C# Class Opc.Ua.AlarmConditionState

Afficher le fichier Open project: OPCFoundation/Misc-Tools Class Usage Examples

Méthodes publiques

Свойство	Type	Description
OnShelve	AlarmConditionShelveEventHandler
OnTimedUnshelve	AlarmConditionTimedUnshelveEventHandler

Méthodes publiques

Méthode	Description
SetActiveEffectiveSubState ( ISystemContext context, Opc.Ua.LocalizedText displayName, System.DateTime transitionTime ) : void	Called when one or more sub-states change state.
SetActiveState ( ISystemContext context, bool active ) : void	Sets the active state of the condition.
SetShelvingState ( ISystemContext context, bool shelved, bool oneShot, double shelvingTime ) : void	Sets the shelving state of the condition.
SetSuppressedState ( ISystemContext context, bool suppressed ) : void	Sets the suppressed state of the condition.

Méthodes protégées

Méthode	Description
Dispose ( bool disposing ) : void	An overrideable version of the Dispose.
IsOneShotShelveExecutable ( ISystemContext context, NodeState node, bool &value ) : ServiceResult	Checks whether the OneShotShelve method is executable.
IsTimedShelveExecutable ( ISystemContext context, NodeState node, bool &value ) : ServiceResult	Checks whether the TimedShelve method is executable.
IsUnshelveExecutable ( ISystemContext context, NodeState node, bool &value ) : ServiceResult	Checks whether the Unshelve method is executable.
OnAfterCreate ( ISystemContext context, NodeState node ) : void	Called after a node is created.
OnOneShotShelve ( ISystemContext context, MethodState method, IList	Handles the OneShotShelve method.
OnReadUnshelveTime ( ISystemContext context, NodeState node, object &value ) : ServiceResult	Checks whether the OneShotShelve method is executable.
OnTimedShelve ( ISystemContext context, MethodState method, Opc.Ua.NodeId objectId, double shelvingTime ) : ServiceResult	Handles the TimedShelve method.
OnUnshelve ( ISystemContext context, MethodState method, IList	Handles the Unshelve method.
UpdateEffectiveState ( ISystemContext context ) : void	Updates the effective state for the condition.

Private Methods

Méthode	Description
OnTimerExpired ( object state ) : void	Called when timed shelve period expires.

Method Details

Dispose() protected méthode

An overrideable version of the Dispose.

protected Dispose ( bool disposing ) : void
disposing	bool
Résultat	void

IsOneShotShelveExecutable() protected méthode

Checks whether the OneShotShelve method is executable.

protected IsOneShotShelveExecutable ( ISystemContext context, NodeState node, bool &value ) : ServiceResult
context	ISystemContext
node	NodeState
value	bool
Résultat	ServiceResult

IsTimedShelveExecutable() protected méthode

Checks whether the TimedShelve method is executable.

protected IsTimedShelveExecutable ( ISystemContext context, NodeState node, bool &value ) : ServiceResult
context	ISystemContext
node	NodeState
value	bool
Résultat	ServiceResult

IsUnshelveExecutable() protected méthode

Checks whether the Unshelve method is executable.

protected IsUnshelveExecutable ( ISystemContext context, NodeState node, bool &value ) : ServiceResult
context	ISystemContext
node	NodeState
value	bool
Résultat	ServiceResult

OnAfterCreate() protected méthode

Called after a node is created.

protected OnAfterCreate ( ISystemContext context, NodeState node ) : void
context	ISystemContext
node	NodeState
Résultat	void

OnOneShotShelve() protected méthode

Handles the OneShotShelve method.

protected OnOneShotShelve ( ISystemContext context, MethodState method, IList
context	ISystemContext
method	MethodState
inputArguments	IList
outputArguments	IList
Résultat	ServiceResult

OnReadUnshelveTime() protected méthode

Checks whether the OneShotShelve method is executable.

protected OnReadUnshelveTime ( ISystemContext context, NodeState node, object &value ) : ServiceResult
context	ISystemContext
node	NodeState
value	object
Résultat	ServiceResult

OnTimedShelve() protected méthode

Handles the TimedShelve method.

protected OnTimedShelve ( ISystemContext context, MethodState method, Opc.Ua.NodeId objectId, double shelvingTime ) : ServiceResult
context	ISystemContext
method	MethodState
objectId	Opc.Ua.NodeId
shelvingTime	double
Résultat	ServiceResult

OnUnshelve() protected méthode

Handles the Unshelve method.

protected OnUnshelve ( ISystemContext context, MethodState method, IList
context	ISystemContext
method	MethodState
inputArguments	IList
outputArguments	IList
Résultat	ServiceResult

SetActiveEffectiveSubState() public méthode

Called when one or more sub-states change state.

public SetActiveEffectiveSubState ( ISystemContext context, Opc.Ua.LocalizedText displayName, System.DateTime transitionTime ) : void
context	ISystemContext	The context.
displayName	Opc.Ua.LocalizedText	The display name for the effective state.
transitionTime	System.DateTime	The transition time.
Résultat	void

SetActiveState() public méthode

Sets the active state of the condition.

public SetActiveState ( ISystemContext context, bool active ) : void
context	ISystemContext	The system context.
active	bool	if set to true the condition is active.
Résultat	void

SetShelvingState() public méthode

Sets the shelving state of the condition.

public SetShelvingState ( ISystemContext context, bool shelved, bool oneShot, double shelvingTime ) : void
context	ISystemContext	The shelving context.
shelved	bool	if set to true shelved.
oneShot	bool	if set to true for a one shot shelve..
shelvingTime	double	The duration of a timed shelve.
Résultat	void

SetSuppressedState() public méthode

Sets the suppressed state of the condition.

public SetSuppressedState ( ISystemContext context, bool suppressed ) : void
context	ISystemContext	The context.
suppressed	bool	if set to true the condition is suppressed.
Résultat	void

UpdateEffectiveState() protected méthode

Updates the effective state for the condition.

protected UpdateEffectiveState ( ISystemContext context ) : void
context	ISystemContext	The context.
Résultat	void

Property Details

OnShelve public_oe property

Raised when the alarm is shelved.

Return code can be used to cancel the operation.

public AlarmConditionShelveEventHandler OnShelve
Résultat	AlarmConditionShelveEventHandler

OnTimedUnshelve public_oe property

Raised when the timed shelving period expires.

public AlarmConditionTimedUnshelveEventHandler OnTimedUnshelve
Résultat	AlarmConditionTimedUnshelveEventHandler