C# Класс CyrusBuilt.MonoPi.Devices.Fireplace.FireplaceBase

Base class for fireplace device abstractions.

Наследование: DeviceBase, IFireplace

Открытые методы

Метод	Описание
CancelTimeout ( ) : void	Cancels a timeout.
Dispose ( ) : void	Releases all resource used by the CyrusBuilt.MonoPi.Devices.Fireplace.FireplaceBase object. Call Dispose when you are finished using the CyrusBuilt.MonoPi.Devices.Fireplace.FireplaceBase. The Dispose method leaves the CyrusBuilt.MonoPi.Devices.Fireplace.FireplaceBase in an unusable state. After calling Dispose, you must release all references to the CyrusBuilt.MonoPi.Devices.Fireplace.FireplaceBase so the garbage collector can reclaim the memory that the CyrusBuilt.MonoPi.Devices.Fireplace.FireplaceBase was occupying.
Off ( ) : void	Turns the fireplace off.
On ( ) : void	Turns the fireplace on.
On ( double timeoutDelay, TimeUnit timeoutUnit ) : void	Turns the fireplace on with the specified timeout. If the operation is not successful within the allotted time, the operation is cancelled for safety reasons.
SetTimeout ( double delay, TimeUnit unit ) : void	Sets the timeout delay.
Shutdown ( ) : void	Shutdown the fireplace.

Защищенные методы

Метод	Описание
CancelTimeoutTask ( ) : void	Cancels the timeout task (if running).
FireplaceBase ( ) : System	Initializes a new instance of the CyrusBuilt.MonoPi.Devices.Fireplace.FireplaceBase class. This is the default constructor.
OnOperationTimedOut ( FireplaceTimeoutEventArgs e ) : void	Raises the operation timed out event.
OnPilotLightStateChanged ( FireplacePilotLightEventArgs e ) : void	Raises the pilot light state changed event.
OnStateChanged ( FireplaceStateChangedEventArgs e ) : void	Raises the state changed event.
StartCancelTask ( ) : void	Starts the cancel task. This will start a task that turns off

Приватные методы

Метод	Описание
InternalStateChangeHandler ( Object sender, FireplaceStateChangedEventArgs e ) : void	An internal handler for the state change event.

Описание методов

CancelTimeout() публичный Метод

Cancels a timeout.

public CancelTimeout ( ) : void
Результат	void

CancelTimeoutTask() защищенный Метод

Cancels the timeout task (if running).

protected CancelTimeoutTask ( ) : void
Результат	void

Dispose() публичный Метод

Releases all resource used by the CyrusBuilt.MonoPi.Devices.Fireplace.FireplaceBase object.

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

public Dispose ( ) : void
Результат	void

FireplaceBase() защищенный Метод

Initializes a new instance of the CyrusBuilt.MonoPi.Devices.Fireplace.FireplaceBase class. This is the default constructor.

protected FireplaceBase ( ) : System
Результат	System

Off() публичный Метод

Turns the fireplace off.

public Off ( ) : void
Результат	void

On() публичный Метод

Turns the fireplace on.

public On ( ) : void
Результат	void

On() публичный Метод

Turns the fireplace on with the specified timeout. If the operation is not successful within the allotted time, the operation is cancelled for safety reasons.

public On ( double timeoutDelay, TimeUnit timeoutUnit ) : void
timeoutDelay	double	/// The timeout delay. ///
timeoutUnit	TimeUnit	/// The time unit of measure for the timeout. ///
Результат	void

OnOperationTimedOut() защищенный Метод

Raises the operation timed out event.

protected OnOperationTimedOut ( FireplaceTimeoutEventArgs e ) : void
e	FireplaceTimeoutEventArgs	/// The event arguments. ///
Результат	void

OnPilotLightStateChanged() защищенный Метод

Raises the pilot light state changed event.

protected OnPilotLightStateChanged ( FireplacePilotLightEventArgs e ) : void
e	FireplacePilotLightEventArgs	/// The event arguments. ///
Результат	void

OnStateChanged() защищенный Метод

Raises the state changed event.

protected OnStateChanged ( FireplaceStateChangedEventArgs e ) : void
e	FireplaceStateChangedEventArgs	/// The event arguments. ///
Результат	void

SetTimeout() публичный Метод

Sets the timeout delay.

public SetTimeout ( double delay, TimeUnit unit ) : void
delay	double	/// The timeout delay. ///
unit	TimeUnit	/// The time unit of measure for the timeout. ///
Результат	void

Shutdown() публичный Метод

Shutdown the fireplace.

public Shutdown ( ) : void
Результат	void

StartCancelTask() защищенный Метод

Starts the cancel task. This will start a task that turns off

protected StartCancelTask ( ) : void
Результат	void