C# Class CyrusBuilt.MonoPi.Components.ComponentBase

Base class for hardware abstraction components.

Inheritance: IComponent

Show file Open project: cyrusbuilt/MonoPi

Public Methods

Method	Description
Dispose ( ) : void	Releases all resources used by the CyrusBuilt.MonoPi.Components.ComponentBase object. Call Dispose when you are finished using the CyrusBuilt.MonoPi.Components.ComponentBase. The Dispose method leaves the CyrusBuilt.MonoPi.Components.ComponentBase in an unusable state. After calling Dispose, you must release all references to the CyrusBuilt.MonoPi.Components.ComponentBase so the garbage collector can reclaim the memory that the CyrusBuilt.MonoPi.Components.ComponentBase was occupying.
HasProperty ( String key ) : System.Boolean	Determines whether this instance has property the specified key.
SetProperty ( String key, String value ) : void	Sets the value of the specified property. If the property does not already exist in the property collection, it will be added.
ToString ( ) : String	Returns a System.String that represents the current CyrusBuilt.MonoPi.Components.ComponentBase.

Protected Methods

Method	Description
ComponentBase ( ) : System	Initializes a new instance of the CyrusBuilt.MonoPi.Components.ComponentBase class. This is the default contructor.
ComponentBase ( String>.Dictionary props ) : System	Initializes a new instance of the CyrusBuilt.MonoPi.Components.ComponentBase class with a properties dictionary.
Dispose ( System.Boolean disposing ) : void	Releaseses all resources used this object.

Method Details

ComponentBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.Components.ComponentBase class. This is the default contructor.

protected ComponentBase ( ) : System
return	System

ComponentBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.Components.ComponentBase class with a properties dictionary.

protected ComponentBase ( String>.Dictionary props ) : System
props	String>.Dictionary	/// Component properties. ///
return	System

Dispose() public method

Releases all resources used by the CyrusBuilt.MonoPi.Components.ComponentBase object.

Call Dispose when you are finished using the CyrusBuilt.MonoPi.Components.ComponentBase. The Dispose method leaves the CyrusBuilt.MonoPi.Components.ComponentBase in an unusable state. After calling Dispose, you must release all references to the CyrusBuilt.MonoPi.Components.ComponentBase so the garbage collector can reclaim the memory that the CyrusBuilt.MonoPi.Components.ComponentBase was occupying.

public Dispose ( ) : void
return	void

Dispose() protected method

Releaseses all resources used this object.

protected Dispose ( System.Boolean disposing ) : void
disposing	System.Boolean	/// Set true if disposing managed resources in addition to unmanaged. ///
return	void

HasProperty() public method

Determines whether this instance has property the specified key.

public HasProperty ( String key ) : System.Boolean
key	String	/// The key name of the property to check for. ///
return	System.Boolean

SetProperty() public method

Sets the value of the specified property. If the property does not already exist in the property collection, it will be added.

public SetProperty ( String key, String value ) : void
key	String	/// The property name (key). ///
value	String	/// The value to assign to the property. ///
return	void

ToString() public method

Returns a System.String that represents the current CyrusBuilt.MonoPi.Components.ComponentBase.

public ToString ( ) : String
return	String