C# Класс Opc.Ua.FiniteStateMachineState

Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
OnAfterTransition StateMachineTransitionHandler
OnBeforeTransition StateMachineTransitionHandler
OnCheckUserPermission StateMachineTransitionHandler

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

Метод Описание
CauseProcessingCompleted ( ISystemContext context, uint causeId ) : void

Updates the state machine to reflect the successful processing of a method.

DoCause ( ISystemContext context, MethodState causeMethod, uint causeId, IList inputArguments, IList outputArguments ) : ServiceResult

Invokes the specified cause.

DoTransition ( ISystemContext context, uint transitionId, uint causeId, IList inputArguments, IList outputArguments ) : ServiceResult

Causes the specified transition to occur.

IsCausePermitted ( ISystemContext context, uint causeId, bool checkUserAccessRights ) : bool

Checks if the cause is permitted given the current state and returns the associated transition.

SetState ( ISystemContext context, uint newState ) : void

Forces the machine into the specified state.

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

Метод Описание
CreateAuditEvent ( ISystemContext context, MethodState causeMethod, uint causeId ) : AuditUpdateStateEventState

Creates an instance of an audit event.

CreateTransitionEvent ( ISystemContext context, uint transitionId, uint causeId ) : TransitionEventState

Creates an instance of an transition event.

GetCurrentStateId ( ) : uint

Returns the current state of for the state machine.

GetNewStateForTransition ( ISystemContext context, uint transitionId ) : uint

Returns the new state for the specified transition. Returns 0 if the transition is not allowed.

GetTransitionForCause ( ISystemContext context, uint causeId ) : uint

Returns the transition for the cause given the current state.

GetTransitionToState ( ISystemContext context, uint targetStateId ) : uint

Returns the transition from the current state to the target state.

InvokeCallback ( StateMachineTransitionHandler callback, ISystemContext context, StateMachineState machine, uint transitionId, uint causeId, IList inputArguments, IList outputArguments ) : ServiceResult

Invokes the callback function if it has been specified.

OnAfterCreate ( ISystemContext context, NodeState node ) : void

Initializes the object as a collection of counters which change value on read.

TransitionHasEffect ( ISystemContext context, uint transitionId ) : bool

Checks if the transition has an effect.

UpdateAuditEvent ( ISystemContext context, MethodState causeMethod, uint causeId, AuditUpdateStateEventState e, ServiceResult result ) : void

Updates an audit event after the method is invoked.

UpdateStateVariable ( ISystemContext context, uint stateId, FiniteStateVariableState variable ) : void

Updates the current state variable.

UpdateTransitionEvent ( ISystemContext context, uint transitionId, uint causeId, TransitionEventState e ) : void

Updates a transition event after the transition is complete.

UpdateTransitionVariable ( ISystemContext context, uint transitionId, FiniteTransitionVariableState variable ) : void

Updates the last transition variable.

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

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

Updates the state machine to reflect the successful processing of a method.
public CauseProcessingCompleted ( ISystemContext context, uint causeId ) : void
context ISystemContext The context.
causeId uint The cause id.
Результат void

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

Creates an instance of an audit event.
protected CreateAuditEvent ( ISystemContext context, MethodState causeMethod, uint causeId ) : AuditUpdateStateEventState
context ISystemContext
causeMethod MethodState
causeId uint
Результат AuditUpdateStateEventState

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

Creates an instance of an transition event.
protected CreateTransitionEvent ( ISystemContext context, uint transitionId, uint causeId ) : TransitionEventState
context ISystemContext
transitionId uint
causeId uint
Результат TransitionEventState

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

Invokes the specified cause.
public DoCause ( ISystemContext context, MethodState causeMethod, uint causeId, IList inputArguments, IList outputArguments ) : ServiceResult
context ISystemContext
causeMethod MethodState
causeId uint
inputArguments IList
outputArguments IList
Результат ServiceResult

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

Causes the specified transition to occur.
public DoTransition ( ISystemContext context, uint transitionId, uint causeId, IList inputArguments, IList outputArguments ) : ServiceResult
context ISystemContext
transitionId uint
causeId uint
inputArguments IList
outputArguments IList
Результат ServiceResult

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

Returns the current state of for the state machine.
protected GetCurrentStateId ( ) : uint
Результат uint

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

Returns the new state for the specified transition. Returns 0 if the transition is not allowed.
protected GetNewStateForTransition ( ISystemContext context, uint transitionId ) : uint
context ISystemContext
transitionId uint
Результат uint

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

Returns the transition for the cause given the current state.
protected GetTransitionForCause ( ISystemContext context, uint causeId ) : uint
context ISystemContext
causeId uint
Результат uint

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

Returns the transition from the current state to the target state.
protected GetTransitionToState ( ISystemContext context, uint targetStateId ) : uint
context ISystemContext
targetStateId uint
Результат uint

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

Invokes the callback function if it has been specified.
protected InvokeCallback ( StateMachineTransitionHandler callback, ISystemContext context, StateMachineState machine, uint transitionId, uint causeId, IList inputArguments, IList outputArguments ) : ServiceResult
callback StateMachineTransitionHandler
context ISystemContext
machine StateMachineState
transitionId uint
causeId uint
inputArguments IList
outputArguments IList
Результат ServiceResult

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

Checks if the cause is permitted given the current state and returns the associated transition.
public IsCausePermitted ( ISystemContext context, uint causeId, bool checkUserAccessRights ) : bool
context ISystemContext
causeId uint
checkUserAccessRights bool
Результат bool

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

Initializes the object as a collection of counters which change value on read.
protected OnAfterCreate ( ISystemContext context, NodeState node ) : void
context ISystemContext
node NodeState
Результат void

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

Forces the machine into the specified state.
public SetState ( ISystemContext context, uint newState ) : void
context ISystemContext
newState uint
Результат void

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

Checks if the transition has an effect.
protected TransitionHasEffect ( ISystemContext context, uint transitionId ) : bool
context ISystemContext
transitionId uint
Результат bool

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

Updates an audit event after the method is invoked.
protected UpdateAuditEvent ( ISystemContext context, MethodState causeMethod, uint causeId, AuditUpdateStateEventState e, ServiceResult result ) : void
context ISystemContext
causeMethod MethodState
causeId uint
e AuditUpdateStateEventState
result ServiceResult
Результат void

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

Updates the current state variable.
protected UpdateStateVariable ( ISystemContext context, uint stateId, FiniteStateVariableState variable ) : void
context ISystemContext
stateId uint
variable FiniteStateVariableState
Результат void

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

Updates a transition event after the transition is complete.
protected UpdateTransitionEvent ( ISystemContext context, uint transitionId, uint causeId, TransitionEventState e ) : void
context ISystemContext
transitionId uint
causeId uint
e TransitionEventState
Результат void

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

Updates the last transition variable.
protected UpdateTransitionVariable ( ISystemContext context, uint transitionId, FiniteTransitionVariableState variable ) : void
context ISystemContext
transitionId uint
variable FiniteTransitionVariableState
Результат void

Описание свойств

OnAfterTransition публичное свойство

Raises after a transition occurs. Errors are ignored.
public StateMachineTransitionHandler OnAfterTransition
Результат StateMachineTransitionHandler

OnBeforeTransition публичное свойство

Raised before a transition occurs.
public StateMachineTransitionHandler OnBeforeTransition
Результат StateMachineTransitionHandler

OnCheckUserPermission публичное свойство

Raised to check whether the current user is allowed to execute the command.
public StateMachineTransitionHandler OnCheckUserPermission
Результат StateMachineTransitionHandler