C# Class Opc.Ua.Server.StateMachine

Defines additional methods for a StateMachine

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

Public Methods

Method	Description
ForceState ( QualifiedName stateName ) : void	Sets the state for the machine without generating any events.
GotoInitialState ( ) : void	Moves the state machine into the initial state.
OnCauseInvoked ( OperationContext context, QualifiedName causeName ) : void	Called when a cause is invoked.
ParentMachineStateChanged ( QualifiedName state, QualifiedName transition ) : void	Updates the state after the parent state changes.
SetState ( OperationContext context, QualifiedName stateName ) : void	Sets the state for the machine.
SetSubState ( OperationContext context, QualifiedName stateName, QualifiedName substateMachine, QualifiedName substateName ) : void	Sets the state for the machine.

Protected Methods

Method	Description
AddTransition ( ILocalNode source ) : void	Called to process a transition that was found in the machine.
BeginTransitionForCause ( OperationContext context, QualifiedName causeName ) : Transition	Begins a transition.
BeginTransitionToState ( OperationContext context, QualifiedName toState ) : Transition	Begins a transition.
ConstructMachine ( object configuration ) : void	Contructs the machine by reading the address space.
ConstructMachineFromType ( NodeId typeDefinitionId ) : void	Contructs the machine by reading the address space.
CreateAuditEvent ( OperationContext context, Transition transition, QualifiedName cause, Exception exception ) : AuditUpdateStateEvent	Creates an audit event for the cause.
EndTransition ( OperationContext context, Transition transition, QualifiedName cause ) : void	Ends a transition (reports events for all effects).
FindContainer ( Type containerType ) : NodeSource	Finds the parent that has the specified type.
GetCollapsedSubstate ( ) : LocalizedText	Returns the collapses substate name for the state machine.
OnAfterCreate ( object configuration ) : void	Creates the members uses to store the state machine structure.
OnAfterTransition ( OperationContext context, Transition transition, QualifiedName cause ) : void	Does any processing after a transition occurs.
OnBeforeTransition ( OperationContext context, Transition transition, QualifiedName cause ) : void	Does any processing before a transition occurs.
ReportAuditEvent ( OperationContext context, Transition transition, QualifiedName cause, Exception exception ) : void	Reports an audit event for the cause.
ReportEffect ( OperationContext context, Transition transition, QualifiedName cause, NodeId effectId ) : void	Reports an effect which is an effect of a transition.
UpdateCollapsedSubstate ( ) : void	Updates the collapses substate name for the state machine.

Private Methods

Method	Description
UpdateState ( State state, Transition transition ) : void	Updates the state of the machine.

Method Details

AddTransition() protected method

Called to process a transition that was found in the machine.

protected AddTransition ( ILocalNode source ) : void
source	ILocalNode
return	void

BeginTransitionForCause() protected method

Begins a transition.

protected BeginTransitionForCause ( OperationContext context, QualifiedName causeName ) : Transition
context	OperationContext
causeName	QualifiedName
return	Transition

BeginTransitionToState() protected method

Begins a transition.

protected BeginTransitionToState ( OperationContext context, QualifiedName toState ) : Transition
context	OperationContext
toState	QualifiedName
return	Transition

ConstructMachine() protected method

Contructs the machine by reading the address space.

protected ConstructMachine ( object configuration ) : void
configuration	object
return	void

ConstructMachineFromType() protected method

Contructs the machine by reading the address space.

protected ConstructMachineFromType ( NodeId typeDefinitionId ) : void
typeDefinitionId	NodeId
return	void

CreateAuditEvent() protected method

Creates an audit event for the cause.

protected CreateAuditEvent ( OperationContext context, Transition transition, QualifiedName cause, Exception exception ) : AuditUpdateStateEvent
context	OperationContext
transition	Transition
cause	QualifiedName
exception	System.Exception
return	AuditUpdateStateEvent

EndTransition() protected method

Ends a transition (reports events for all effects).

protected EndTransition ( OperationContext context, Transition transition, QualifiedName cause ) : void
context	OperationContext
transition	Transition
cause	QualifiedName
return	void

FindContainer() protected method

Finds the parent that has the specified type.

protected FindContainer ( Type containerType ) : NodeSource
containerType	System.Type
return	NodeSource

ForceState() public method

Sets the state for the machine without generating any events.

public ForceState ( QualifiedName stateName ) : void
stateName	QualifiedName
return	void

GetCollapsedSubstate() protected method

Returns the collapses substate name for the state machine.

protected GetCollapsedSubstate ( ) : LocalizedText
return	LocalizedText

GotoInitialState() public method

Moves the state machine into the initial state.

public GotoInitialState ( ) : void
return	void

OnAfterCreate() protected method

Creates the members uses to store the state machine structure.

protected OnAfterCreate ( object configuration ) : void
configuration	object
return	void

OnAfterTransition() protected method

Does any processing after a transition occurs.

protected OnAfterTransition ( OperationContext context, Transition transition, QualifiedName cause ) : void
context	OperationContext
transition	Transition
cause	QualifiedName
return	void

OnBeforeTransition() protected method

Does any processing before a transition occurs.

protected OnBeforeTransition ( OperationContext context, Transition transition, QualifiedName cause ) : void
context	OperationContext
transition	Transition
cause	QualifiedName
return	void

OnCauseInvoked() public method

Called when a cause is invoked.

public OnCauseInvoked ( OperationContext context, QualifiedName causeName ) : void
context	OperationContext
causeName	QualifiedName
return	void

ParentMachineStateChanged() public method

Updates the state after the parent state changes.

public ParentMachineStateChanged ( QualifiedName state, QualifiedName transition ) : void
state	QualifiedName
transition	QualifiedName
return	void

ReportAuditEvent() protected method

Reports an audit event for the cause.

protected ReportAuditEvent ( OperationContext context, Transition transition, QualifiedName cause, Exception exception ) : void
context	OperationContext
transition	Transition
cause	QualifiedName
exception	System.Exception
return	void

ReportEffect() protected method

Reports an effect which is an effect of a transition.

protected ReportEffect ( OperationContext context, Transition transition, QualifiedName cause, NodeId effectId ) : void
context	OperationContext
transition	Transition
cause	QualifiedName
effectId	NodeId
return	void

SetState() public method

Sets the state for the machine.

public SetState ( OperationContext context, QualifiedName stateName ) : void
context	OperationContext
stateName	QualifiedName
return	void

SetSubState() public method

Sets the state for the machine.

public SetSubState ( OperationContext context, QualifiedName stateName, QualifiedName substateMachine, QualifiedName substateName ) : void
context	OperationContext
stateName	QualifiedName
substateMachine	QualifiedName
substateName	QualifiedName
return	void

UpdateCollapsedSubstate() protected method

Updates the collapses substate name for the state machine.

protected UpdateCollapsedSubstate ( ) : void
return	void