C# Class CyrusBuilt.MonoPi.IO.PiFaceGpioBase

Base class for the GPIO pins on the PiFace.

Inheritance: IPiFaceGPIO

Mostrar archivo Open project: cyrusbuilt/MonoPi

Protected Properties

Property	Type	Description
_initValue	PinState
_mode	PinMode

Public Methods

Method	Description
Dispose ( ) : void	Releases all resource used by the CyrusBuilt.MonoPi.IO.PiFaceGpioBase object. Call Dispose when you are finished using the CyrusBuilt.MonoPi.IO.PiFaceGpioBase. The Dispose method leaves the CyrusBuilt.MonoPi.IO.PiFaceGpioBase in an unusable state. After calling Dispose, you must release all references to the CyrusBuilt.MonoPi.IO.PiFaceGpioBase so the garbage collector can reclaim the memory that the CyrusBuilt.MonoPi.IO.PiFaceGpioBase was occupying.
Provision ( ) : void	Provisions the pin (initialize to specified mode and make active).
Pulse ( Int32 millis ) : void	Pulse the pin output for the specified number of milliseconds.
Read ( ) : PinState	Read a value from the pin.
ToString ( ) : string	Returns a String that represents the current CyrusBuilt.MonoPi.IO.PiFaceGpioBase.
Write ( PinState value ) : void	Write the specified value to the pin.

Protected Methods

Method	Description
GetGpioPinNumber ( GpioPins pin ) : String	Gets the GPIO pin number.
OnStateChanged ( PinStateChangeEventArgs e ) : void	Raises the state changed event.
PiFaceGpioBase ( PiFacePins pin ) : System	Initializes a new instance of the CyrusBuilt.MonoPi.IO.PiFaceGpioBase class with the physical pin represented by this class.
PiFaceGpioBase ( PiFacePins pin, PinState initialValue ) : System	Initializes a new instance of the CyrusBuilt.MonoPi.IO.PiFaceGpioBase class with the physical pin represented by this class.

Method Details

Dispose() public method

Releases all resource used by the CyrusBuilt.MonoPi.IO.PiFaceGpioBase object.

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

public Dispose ( ) : void
return	void

GetGpioPinNumber() protected static method

Gets the GPIO pin number.

protected static GetGpioPinNumber ( GpioPins pin ) : String
pin	GpioPins	/// The GPIO pin. ///
return	String

OnStateChanged() protected method

Raises the state changed event.

protected OnStateChanged ( PinStateChangeEventArgs e ) : void
e	PinStateChangeEventArgs	/// The event arguments. ///
return	void

PiFaceGpioBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.IO.PiFaceGpioBase class with the physical pin represented by this class.

protected PiFaceGpioBase ( PiFacePins pin ) : System
pin	PiFacePins	/// The physical pin being wrapped by this class. ///
return	System

PiFaceGpioBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.IO.PiFaceGpioBase class with the physical pin represented by this class.

protected PiFaceGpioBase ( PiFacePins pin, PinState initialValue ) : System
pin	PiFacePins	/// The physical pin being wrapped by this class. ///
initialValue	PinState	/// Initial value. ///
return	System

Provision() public abstract method

Provisions the pin (initialize to specified mode and make active).

public abstract Provision ( ) : void
return	void

Pulse() public method

Pulse the pin output for the specified number of milliseconds.

public Pulse ( Int32 millis ) : void
millis	System.Int32	/// The number of milliseconds to wait between states. ///
return	void

Read() public abstract method

Read a value from the pin.

public abstract Read ( ) : PinState
return	PinState

ToString() public method

Returns a String that represents the current CyrusBuilt.MonoPi.IO.PiFaceGpioBase.

public ToString ( ) : string
return	string

Write() public method

Write the specified value to the pin.

public Write ( PinState value ) : void
value	PinState	/// If set to true value. ///
return	void

Property Details

_initValue protected_oe property

protected PinState _initValue
return	PinState

_mode protected_oe property

protected PinMode _mode
return	PinMode