C# Class Opc.Ua.AcknowledgeableConditionState

ファイルを表示 Open project: OPCFoundation/UA-.NETStandardLibrary Class Usage Examples

Public Properties

Property	Type	Description
OnAcknowledge	ConditionAddCommentEventHandler
OnConfirm	ConditionAddCommentEventHandler

Public Methods

Method	Description
SetAcknowledgedState ( ISystemContext context, bool acknowledged ) : void	Sets the acknowledged state of the condition.
SetConfirmedState ( ISystemContext context, bool confirmed ) : void	Sets the confirmed state of the condition.

Protected Methods

Method	Description
OnAcknowledgeCalled ( ISystemContext context, MethodState method, Opc.Ua.NodeId objectId, byte eventId, Opc.Ua.LocalizedText comment ) : ServiceResult	Called when the Acknowledge method is called.
OnAfterCreate ( ISystemContext context, NodeState node ) : void	Called after a node is created.
OnConfirmCalled ( ISystemContext context, MethodState method, Opc.Ua.NodeId objectId, byte eventId, Opc.Ua.LocalizedText comment ) : ServiceResult	Called when the Confirm method is called.
ProcessBeforeAcknowledge ( ISystemContext context, byte eventId, Opc.Ua.LocalizedText comment ) : ServiceResult	Does any processing before adding a comment to a condition.
ProcessBeforeConfirm ( ISystemContext context, byte eventId, Opc.Ua.LocalizedText comment ) : ServiceResult	Does any processing before adding a comment to a condition.
UpdateEffectiveState ( ISystemContext context ) : void	Updates the effective state for the condition.
UpdateStateAfterAcknowledge ( ISystemContext context ) : void	Updates the condition state after enabling.
UpdateStateAfterConfirm ( ISystemContext context ) : void	Updates the condition state after enabling.
UpdateStateAfterUnacknowledge ( ISystemContext context ) : void	Updates the condition state after disabling.
UpdateStateAfterUnconfirm ( ISystemContext context ) : void	Updates the condition state after disabling.

Method Details

OnAcknowledgeCalled() protected method

Called when the Acknowledge method is called.

protected OnAcknowledgeCalled ( ISystemContext context, MethodState method, Opc.Ua.NodeId objectId, byte eventId, Opc.Ua.LocalizedText comment ) : ServiceResult
context	ISystemContext	The system context.
method	MethodState	The method being called.
objectId	Opc.Ua.NodeId	The id of the object.
eventId	byte	The identifier for the event which is the target for the comment.
comment	Opc.Ua.LocalizedText	The comment.
return	ServiceResult

OnAfterCreate() protected method

Called after a node is created.

protected OnAfterCreate ( ISystemContext context, NodeState node ) : void
context	ISystemContext
node	NodeState
return	void

OnConfirmCalled() protected method

Called when the Confirm method is called.

protected OnConfirmCalled ( ISystemContext context, MethodState method, Opc.Ua.NodeId objectId, byte eventId, Opc.Ua.LocalizedText comment ) : ServiceResult
context	ISystemContext	The system context.
method	MethodState	The method being called.
objectId	Opc.Ua.NodeId	The id of the object.
eventId	byte	The identifier for the event which is the target for the comment.
comment	Opc.Ua.LocalizedText	The comment.
return	ServiceResult

ProcessBeforeAcknowledge() protected method

Does any processing before adding a comment to a condition.

protected ProcessBeforeAcknowledge ( ISystemContext context, byte eventId, Opc.Ua.LocalizedText comment ) : ServiceResult
context	ISystemContext	The system context.
eventId	byte	The identifier for the event which is the target for the comment.
comment	Opc.Ua.LocalizedText	The comment.
return	ServiceResult

ProcessBeforeConfirm() protected method

Does any processing before adding a comment to a condition.

protected ProcessBeforeConfirm ( ISystemContext context, byte eventId, Opc.Ua.LocalizedText comment ) : ServiceResult
context	ISystemContext	The system context.
eventId	byte	The identifier for the event which is the target for the comment.
comment	Opc.Ua.LocalizedText	The comment.
return	ServiceResult

SetAcknowledgedState() public method

Sets the acknowledged state of the condition.

public SetAcknowledgedState ( ISystemContext context, bool acknowledged ) : void
context	ISystemContext	The system context.
acknowledged	bool	if set to true the condition is acknowledged.
return	void

SetConfirmedState() public method

Sets the confirmed state of the condition.

public SetConfirmedState ( ISystemContext context, bool confirmed ) : void
context	ISystemContext	The context.
confirmed	bool	if set to true the condition is confirmed.
return	void

UpdateEffectiveState() protected method

Updates the effective state for the condition.

protected UpdateEffectiveState ( ISystemContext context ) : void
context	ISystemContext	The context.
return	void

UpdateStateAfterAcknowledge() protected method

Updates the condition state after enabling.

protected UpdateStateAfterAcknowledge ( ISystemContext context ) : void
context	ISystemContext	The system context.
return	void

UpdateStateAfterConfirm() protected method

Updates the condition state after enabling.

protected UpdateStateAfterConfirm ( ISystemContext context ) : void
context	ISystemContext	The system context.
return	void

UpdateStateAfterUnacknowledge() protected method

Updates the condition state after disabling.

protected UpdateStateAfterUnacknowledge ( ISystemContext context ) : void
context	ISystemContext	The system context.
return	void

UpdateStateAfterUnconfirm() protected method

Updates the condition state after disabling.

protected UpdateStateAfterUnconfirm ( ISystemContext context ) : void
context	ISystemContext	The system context.
return	void

Property Details

OnAcknowledge public_oe property

Raised when a condition is acknowledged.

Return code can be used to cancel the operation.

public ConditionAddCommentEventHandler OnAcknowledge
return	ConditionAddCommentEventHandler

OnConfirm public_oe property

Raised when a condition is confirmed.

Return code can be used to cancel the operation.

public ConditionAddCommentEventHandler OnConfirm
return	ConditionAddCommentEventHandler