C# Class CyrusBuilt.MonoPi.Devices.Sprinkler.SprinklerControllerBase

Sprinkler controller base class.
Inheritance: DeviceBase, ISprinklerController
Exibir arquivo Open project: cyrusbuilt/MonoPi

Public Methods

Method Description
Dispose ( ) : void

Releases all resource used by the CyrusBuilt.MonoPi.Devices.Sprinkler.SprinklerControllerBase object.

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

IsOffForZone ( Int32 zone ) : System.Boolean

Determines whether the specified zone is off.
IsOnForZone ( Int32 zone ) : System.Boolean

Determines whether the specified zone is on.
Off ( Int32 zone ) : void

Turns the specified zone off.
OffAllZones ( ) : void

Turns off all zones.
On ( Int32 zone ) : void

Turns the specified zone on.
OnAllZones ( ) : void

Turns all zones on.
SetState ( Int32 zone, System.Boolean on ) : void

Sets the state of the specified zone.

Protected Methods

Method Description
OnZoneStateChanged ( ZoneStateChangeEventArgs e ) : void

Raises the zone state changed event.
SprinklerControllerBase ( ) : System

Initializes a new instance of the CyrusBuilt.MonoPi.Devices.Sprinkler.SprinklerControllerBase class. This is the default constructor.

Method Details

Dispose() public method

Releases all resource used by the CyrusBuilt.MonoPi.Devices.Sprinkler.SprinklerControllerBase object.
Call Dispose when you are finished using the CyrusBuilt.MonoPi.Devices.Sprinkler.SprinklerControllerBase. The Dispose method leaves the CyrusBuilt.MonoPi.Devices.Sprinkler.SprinklerControllerBase in an unusable state. After calling Dispose, you must release all references to the CyrusBuilt.MonoPi.Devices.Sprinkler.SprinklerControllerBase so the garbage collector can reclaim the memory that the CyrusBuilt.MonoPi.Devices.Sprinkler.SprinklerControllerBase was occupying.
public Dispose ( ) : void
return void

IsOffForZone() public method

Determines whether the specified zone is off.
public IsOffForZone ( Int32 zone ) : System.Boolean
zone System.Int32 /// The zone to check. ///
return System.Boolean

IsOnForZone() public method

Determines whether the specified zone is on.
public IsOnForZone ( Int32 zone ) : System.Boolean
zone System.Int32 /// The zone to check. ///
return System.Boolean

Off() public method

Turns the specified zone off.
public Off ( Int32 zone ) : void
zone System.Int32 /// The zone to turn off. ///
return void

OffAllZones() public method

Turns off all zones.
public OffAllZones ( ) : void
return void

On() public method

Turns the specified zone on.
public On ( Int32 zone ) : void
zone System.Int32 /// The zone to turn on. ///
return void

OnAllZones() public method

Turns all zones on.
public OnAllZones ( ) : void
return void

OnZoneStateChanged() protected method

Raises the zone state changed event.
protected OnZoneStateChanged ( ZoneStateChangeEventArgs e ) : void
e ZoneStateChangeEventArgs /// The event arguments. ///
return void

SetState() public method

Sets the state of the specified zone.
public SetState ( Int32 zone, System.Boolean on ) : void
zone System.Int32 /// The zone to set the state of. ///
on System.Boolean /// Set true to turn on the specified zone. ///
return void

SprinklerControllerBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.Devices.Sprinkler.SprinklerControllerBase class. This is the default constructor.
protected SprinklerControllerBase ( ) : System
return System