C# Class CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase

Base class for motion sensor abstraction components.
Inheritance: IMotionSensor
ファイルを表示 Open project: cyrusbuilt/MonoPi

Public Methods

Method Description
Dispose ( ) : void

Releases all resource used by the CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase object.

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

HasProperty ( String key ) : System.Boolean

Determines whether this instance has property the specified key.

ToString ( ) : String

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

Protected Methods

Method Description
Dispose ( System.Boolean disposing ) : void

Releaseses all resources used this object.

MotionSensorBase ( ) : System

Initializes a new instance of the CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase class. This is the default constructor.

MotionSensorBase ( IGpio pin ) : System

Initializes a new instance of the CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase class.

OnMotionDetectionStateChanged ( MotionDetectedEventArgs e ) : void

Raises the motion detection state changed event.

Method Details

Dispose() public method

Releases all resource used by the CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase object.
Call CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase.Dispose when you are finished using the CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase. The CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase.Dispose method leaves the CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase in an unusable state. After calling CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase.Dispose, you must release all references to the CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase so the garbage collector can reclaim the memory that the CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase 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

MotionSensorBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase class. This is the default constructor.
protected MotionSensorBase ( ) : System
return System

MotionSensorBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase class.
/// cannot be null. ///
protected MotionSensorBase ( IGpio pin ) : System
pin IGpio /// The pin being used to read the sensor input. ///
return System

OnMotionDetectionStateChanged() protected method

Raises the motion detection state changed event.
protected OnMotionDetectionStateChanged ( MotionDetectedEventArgs e ) : void
e MotionDetectedEventArgs /// The event arguments. ///
return void

ToString() public method

Returns a System.String that represents the current CyrusBuilt.MonoPi.Components.Sensors.MotionSensorBase.
public ToString ( ) : String
return String