C# 클래스 CyrusBuilt.MonoPi.Devices.Fireplace.FireplaceBase

Base class for fireplace device abstractions.
상속: DeviceBase, IFireplace
파일 보기 프로젝트 열기: cyrusbuilt/MonoPi

공개 메소드들

메소드 설명
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