https://reference.opcfoundation.org/v105/Core/docs/Part10/5.2.1
More...
Inherits UnifiedAutomation.UaServer.FiniteStateMachineModel.
|
enum | State : uint { State.Ready = 12,
State.Running = 13,
State.Suspended = 14,
State.Halted = 11
} |
| The enumeration representing the possible states of the state machine. More...
|
|
enum | Transition : uint {
Transition.HaltedToReady = 1,
Transition.ReadyToHalted = 9,
Transition.ReadyToRunning = 2,
Transition.RunningToHalted = 3,
Transition.RunningToReady = 4,
Transition.RunningToSuspended = 5,
Transition.SuspendedToHalted = 7,
Transition.SuspendedToReady = 8,
Transition.SuspendedToRunning = 6
} |
| The enumeration representing the possible transitions of the state machine. More...
|
|
|
| ProgramStateMachineModel () |
| Initializes a new instance of the ProgramStateMachineModel class. More...
|
|
| ProgramStateMachineModel (ProgramStateMachineModel template, DummyArgument dummy=null) |
| Initializes a new instance of the ProgramStateMachineModel class. More...
|
|
void | RaiseSwitchedEvent (State?oldState, State?state, Transition?transition) |
| Raises the Switched event. More...
|
|
virtual void | SwitchToState (State?state, Transition?transition=null) |
| Switch to the given state. More...
|
|
| FiniteStateMachineModel () |
| Initializes a new instance of the FiniteStateMachineModel class. More...
|
|
| FiniteStateMachineModel (FiniteStateMachineModel template, DummyArgument dummy=null) |
| Initializes a new instance of the FiniteStateMachineModel class. More...
|
|
| StateMachineModel () |
| Initializes a new instance of the StateMachineModel class. More...
|
|
| StateMachineModel (StateMachineModel template, DummyArgument dummy=null) |
| Initializes a new instance of the StateMachineModel class. More...
|
|
| BaseObjectModel () |
| Initializes a new instance of the BaseObjectModel class. More...
|
|
| BaseObjectModel (BaseObjectModel template, DummyArgument dummy=null) |
| Initializes a new instance of the BaseObjectModel class. More...
|
|
virtual ModelHandle | GetModelHandle (StringTable namespaceUris, object instance) |
| Gets the metadata handle. More...
|
|
virtual DataValue | GetValue (IMapperContext context, ModelMapping mapping) |
| Gets the value associated with the mapping. More...
|
|
virtual bool | SetValue (IMapperContext context, ModelMapping mapping, DataValue value) |
| Sets the value associated with the mapping. More...
|
|
StatusCode | GetStatusCode (string propertyName) |
| Retrieve the status code for the given property. If no status code was explicitly set, StatusCodes.Good will be returned. - Parameters
-
propertyName | The property name. |
- Returns
- The status code of the property.
|
|
void | SetStatusCode (string propertyName, StatusCode statusCode) |
| Sets the status code of the given property. More...
|
|
|
bool | AutoDelete [get, set] |
| Gets or sets the AutoDelete More...
|
|
new FiniteStateVariableModel | CurrentState [get, set] |
| Gets or sets the CurrentState More...
|
|
bool | Deletable [get, set] |
| Gets or sets the Deletable More...
|
|
BaseObjectModel | FinalResultData [get, set] |
| https://reference.opcfoundation.org/v105/Core/docs/Part10/A.2.6/#A.2.6.2 More...
|
|
new FiniteTransitionVariableModel | LastTransition [get, set] |
| Gets or sets the LastTransition More...
|
|
ProgramDiagnostic2Model | ProgramDiagnostic [get, set] |
| Gets or sets the ProgramDiagnostic More...
|
|
int | RecycleCount [get, set] |
| Gets or sets the RecycleCount More...
|
|
State | InternalState [get, protected set] |
| The FiniteStateMachineModel.CurrentState as the enumeration value. More...
|
|
Transition | InternalTransition [get, protected set] |
| The FiniteStateMachineModel.LastTransition as the enumeration value. More...
|
|
NodeId[] | AvailableStates [get, set] |
| Gets or sets the AvailableStates More...
|
|
NodeId[] | AvailableTransitions [get, set] |
| Gets or sets the AvailableTransitions More...
|
|
new FiniteStateVariableModel | CurrentState [get, set] |
| Stores the current state of an instance of the FiniteStateMachineType. More...
|
|
new FiniteTransitionVariableModel | LastTransition [get, set] |
| Stores the last transition which occurred in an instance of the FiniteStateMachineType. More...
|
|
StateVariableModel | CurrentState [get, set] |
| Stores the current state of an instance of the StateMachineType. More...
|
|
TransitionVariableModel | LastTransition [get, set] |
| Stores the last transition which occurred in an instance of the StateMachineType. More...
|
|
ModelHandle | ModelHandle [get, set] |
| Gets or sets the metadata handle. More...
|
|
object | UserData [get, set] |
| Gets or sets the user data. More...
|
|
bool | HasStatusCodes [get] |
| true if no property has an explicit set status code. Hence when all status codes are implicit StatusCodes.Good. More...
|
|
|
bool | HasStatusCodes => m_statusCodes != null && m_statusCodes.Count > 0 |
|
void | RaisePropertyChangedEvent ([CallerMemberName] string propertyName=null) |
| Raises an property change event. More...
|
|
void | RaisePropertyChangeRequestedEvent< T > (T value, [CallerMemberName] string propertyName=null) |
| Called when the value of a property is supposed to be changed. More...
|
|
bool | SetField< T > (ref T field, T value, [CallerMemberName] string propertyName=null) |
| Sets the backing field to the new value, and triggers a property change event, if the value has changed. More...
|
|
The enumeration representing the possible states of the state machine.
Enumerator |
---|
Ready |
The Ready state.
|
Running |
The Running state.
|
Suspended |
The Suspended state.
|
Halted |
The Halted state.
|
The enumeration representing the possible transitions of the state machine.
Enumerator |
---|
HaltedToReady |
Transition from State.Halted to State.Ready.
|
ReadyToHalted |
Transition from State.Ready to State.Halted.
|
ReadyToRunning |
Transition from State.Ready to State.Running.
|
RunningToHalted |
Transition from State.Running to State.Halted.
|
RunningToReady |
Transition from State.Running to State.Ready.
|
RunningToSuspended |
Transition from State.Running to State.Suspended.
|
SuspendedToHalted |
Transition from State.Suspended to State.Halted.
|
SuspendedToReady |
Transition from State.Suspended to State.Ready.
|
SuspendedToRunning |
Transition from State.Suspended to State.Running.
|
UnifiedAutomation.UaServer.ProgramStateMachineModel.ProgramStateMachineModel |
( |
| ) |
|
Initializes a new instance of the ProgramStateMachineModel class.
- Parameters
-
template | The template. |
dummy | Dummy argument to enable writing own constructors that are called by the generated code. |
static LocalizedText UnifiedAutomation.UaServer.ProgramStateMachineModel.GetLocalizedText |
( |
State |
state | ) |
|
|
static |
Retrieves a LocalizedText for the given state value.
- Parameters
-
state | The state to get the text. |
- Returns
- The text.
Retrieves a LocalizedText for the given transition value.
- Parameters
-
transition | The transition to get the text. |
- Returns
- The transition.
static QualifiedName UnifiedAutomation.UaServer.ProgramStateMachineModel.GetName |
( |
State |
state | ) |
|
|
static |
Retrieves a QualifiedName for the given state value.
- Parameters
-
state | The state to get the name. |
- Returns
- The name.
Retrieves a QualifiedName for the given transition value.
- Parameters
-
transition | The transition to get the name. |
- Returns
- The name.
static NodeId UnifiedAutomation.UaServer.ProgramStateMachineModel.GetNodeId |
( |
State |
state | ) |
|
|
static |
Retrieves the NodeId for the given state value.
- Parameters
-
state | The state to get the NodeId. |
- Returns
- The NodeId.
static NodeId UnifiedAutomation.UaServer.ProgramStateMachineModel.GetNodeId |
( |
Transition |
transition | ) |
|
|
static |
Retrieves the NodeId for the given transition value.
- Parameters
-
transition | The transition to get the NodeId. |
- Returns
- The NodeId.
static IEnumerable<Transition> UnifiedAutomation.UaServer.ProgramStateMachineModel.GetTransitions |
( |
State |
oldState, |
|
|
State |
newState |
|
) |
| |
|
static |
A sequence of all possible transition for the given states.
- Parameters
-
oldState | The From state. |
newState | The To state. |
- Returns
- A sequence of all possible transition for the given states. The sequence can be empty, but it will never be null.
void UnifiedAutomation.UaServer.ProgramStateMachineModel.RaiseSwitchedEvent |
( |
State? |
oldState, |
|
|
State? |
state, |
|
|
Transition? |
transition |
|
) |
| |
virtual void UnifiedAutomation.UaServer.ProgramStateMachineModel.SwitchToState |
( |
State? |
state, |
|
|
Transition? |
transition = null |
|
) |
| |
|
virtual |
Switch to the given state.
- Parameters
-
state | The state. |
transition | The transition. |
If the transition value is null
the method will take the first transition that is possible. If there is no possible transition or if a transition was passed that is not possible for the old and new state combination, null
will be assigned to the InternalTransition and FiniteStateMachineModel.LastTransition properties. It is up to the caller to avoid such situations.
A null
value for the state will be translated to the specification conform status code StatusCodes.BadStateNotActive.
State UnifiedAutomation.UaServer.ProgramStateMachineModel.m_state |
|
protected |
The current state of the state machine.
Transition UnifiedAutomation.UaServer.ProgramStateMachineModel.m_transition |
|
protected |
The last transition of the state machine.
bool UnifiedAutomation.UaServer.ProgramStateMachineModel.AutoDelete |
|
getset |
Gets or sets the AutoDelete
Gets or sets the CurrentState
bool UnifiedAutomation.UaServer.ProgramStateMachineModel.Deletable |
|
getset |
Gets or sets the Deletable
BaseObjectModel UnifiedAutomation.UaServer.ProgramStateMachineModel.FinalResultData |
|
getset |
State UnifiedAutomation.UaServer.ProgramStateMachineModel.InternalState |
|
getprotected set |
Transition UnifiedAutomation.UaServer.ProgramStateMachineModel.InternalTransition |
|
getprotected set |
Gets or sets the LastTransition
Gets or sets the ProgramDiagnostic
int UnifiedAutomation.UaServer.ProgramStateMachineModel.RecycleCount |
|
getset |
Gets or sets the RecycleCount
EventHandler<StateMachineEventArgs<State?, Transition?> > UnifiedAutomation.UaServer.ProgramStateMachineModel.Switched |
Occurs when the SwitchToState method was called.
Note, the event is also emitted when the state stays the same.
The documentation for this class was generated from the following file:
- D:/work/uasdknet_master/src/UaServer/Models/UaBaseClasses.cs