C# Class CyrusBuilt.MonoPi.Components.Temperature.TemperatureSensorBase

Base class for temperature sensor abstraction components.
Inheritance: ComponentBase, ITemperatureSensor
ファイルを表示 Open project: cyrusbuilt/MonoPi

Public Methods

Method Description
Dispose ( ) : void

Releases all resource used by the CyrusBuilt.MonoPi.Components.Temperature.TemperatureSensorBase object.

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

GetTemperature ( TemperatureScale scale ) : Double

Gets the temperature value.
ToString ( ) : string

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

Protected Methods

Method Description
Dispose ( System.Boolean disposing ) : void

Releaseses all resources used this object.
OnTemperatureChanged ( TemperatureChangeEventArgs e ) : void

Raises the temperature changed event.
TemperatureSensorBase ( ) : System

Initializes a new instance of the CyrusBuilt.MonoPi.Components.Temperature.TemperatureSensorBase class. This is the default constructor.
TemperatureSensorBase ( IGpio clock, IGpio data, IGpio reset ) : System

Initializes a new instance of the CyrusBuilt.MonoPi.Components.Temperature.TemperatureSensorBase class with the clock, data, and reset pins needed for the sensor.

Method Details

Dispose() public method

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

GetTemperature() public method

Gets the temperature value.
public GetTemperature ( TemperatureScale scale ) : Double
scale TemperatureScale /// The scale to get the temperature measurement in. ///
return Double

OnTemperatureChanged() protected method

Raises the temperature changed event.
protected OnTemperatureChanged ( TemperatureChangeEventArgs e ) : void
e TemperatureChangeEventArgs /// The event arguments. ///
return void

TemperatureSensorBase() protected method

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

TemperatureSensorBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.Components.Temperature.TemperatureSensorBase class with the clock, data, and reset pins needed for the sensor.
/// Pins cannot be null. ///
protected TemperatureSensorBase ( IGpio clock, IGpio data, IGpio reset ) : System
clock IGpio /// The GPIO pin used for the clock. ///
data IGpio /// The GPIO pin used for data. ///
reset IGpio /// The GPIO pin used to trigger reset. ///
return System

ToString() public method

Returns a System.String that represents the current CyrusBuilt.MonoPi.Components.Temperature.TemperatureSensorBase.
public ToString ( ) : string
return string