.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaServer.FileTransferStateMachineModel Class Reference

https://reference.opcfoundation.org/v105/Core/docs/Part20/4.4.6 More...

Inherits UnifiedAutomation.UaServer.FiniteStateMachineModel, and UnifiedAutomation.UaServer.IMethodDispatcher.

Public Types

enum  State : uint {
  State.Idle = 1, State.ReadPrepare = 2, State.ReadTransfer = 3, State.ApplyWrite = 4,
  State.Error = 5
}
 The enumeration representing the possible states of the state machine. More...
 
enum  Transition : uint {
  Transition.ApplyWriteToError = 45, Transition.ApplyWriteToIdle = 41, Transition.ErrorToIdle = 51, Transition.IdleToApplyWrite = 14,
  Transition.IdleToReadPrepare = 12, Transition.ReadPrepareToError = 25, Transition.ReadPrepareToReadTransfer = 23, Transition.ReadTransferToError = 35,
  Transition.ReadTransferToIdle = 31
}
 The enumeration representing the possible transitions of the state machine. More...
 

Public Member Functions

 FileTransferStateMachineModel ()
 Initializes a new instance of the FileTransferStateMachineModel class. More...
 
 FileTransferStateMachineModel (FileTransferStateMachineModel template, DummyArgument dummy=null)
 Initializes a new instance of the FileTransferStateMachineModel 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...
 
virtual CallMethodEventHandler GetMethodDispatcher (RequestContext context, NodeId objectId, NodeId methodId)
 Gets the method dispatcher. More...
 
virtual StatusCode DispatchMethod (RequestContext context, MethodHandle methodHandle, IList< Variant > inputArguments, List< StatusCode > inputArgumentResults, List< Variant > outputArguments)
 Dispatches the method. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.FiniteStateMachineModel
 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...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.StateMachineModel
 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...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseObjectModel
 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...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
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
propertyNameThe property name.
Returns
The status code of the property.

 
void SetStatusCode (string propertyName, StatusCode statusCode)
 Sets the status code of the given property. More...
 

Static Public Member Functions

static IEnumerable< TransitionGetTransitions (State oldState, State newState)
 A sequence of all possible transition for the given states. More...
 
static LocalizedText GetLocalizedText (State state)
 Retrieves a LocalizedText for the given state value. More...
 
static QualifiedName GetName (State state)
 Retrieves a QualifiedName for the given state value. More...
 
static NodeId GetNodeId (State state)
 Retrieves the NodeId for the given state value. More...
 
static LocalizedText GetLocalizedText (Transition transition)
 Retrieves a LocalizedText for the given transition value. More...
 
static QualifiedName GetName (Transition transition)
 Retrieves a QualifiedName for the given transition value. More...
 
static NodeId GetNodeId (Transition transition)
 Retrieves the NodeId for the given transition value. More...
 

Protected Attributes

State m_state
 The current state of the state machine. More...
 
Transition m_transition
 The last transition of the state machine. More...
 

Properties

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...
 
IFileTransferStateMachineMethods FileTransferStateMachineMethods [get, set]
 Gets or sets the FileTransferStateMachine methods. More...
 
- Properties inherited from UnifiedAutomation.UaServer.FiniteStateMachineModel
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...
 
- Properties inherited from UnifiedAutomation.UaServer.StateMachineModel
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...
 
- Properties inherited from UnifiedAutomation.UaServer.ModelControllerBase
ModelHandle ModelHandle [get, set]
 Gets or sets the metadata handle. More...
 
object UserData [get, set]
 Gets or sets the user data. More...
 
- Properties inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
bool HasStatusCodes [get]
 true if no property has an explicit set status code. Hence when all status codes are implicit StatusCodes.Good. More...
 

Events

EventHandler
< StateMachineEventArgs< State?,
Transition?> > 
Switched
 Occurs when the SwitchToState method was called. More...
 
- Events inherited from UnifiedAutomation.UaServer.ModelControllerBase
PropertyChangedEventHandler PropertyChanged
 Occurs when a property value changes. More...
 
EventHandler
< PropertyChangeRequestedEventArgs
PropertyChangeRequested
 The event is emitted just before the value will be changed, and gives the observer the opportunity to reject or adjust (e.g. clamp) the property change by setting the PropertyChangeRequestedEventArgs.StatusCode and PropertyChangeRequestedEventArgs.Value properties. More...
 
EventHandler
< StatusCodeChangedEventArgs
StatusCodeChanged
 
- Events inherited from UnifiedAutomation.UaServer.INotifyPropertyChangeRequested
EventHandler
< PropertyChangeRequestedEventArgs
PropertyChangeRequested
 The property change request event. More...
 
- Events inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
EventHandler
< StatusCodeChangedEventArgs
StatusCodeChanged
 Occurs if the status code of a property was changed. More...
 

Additional Inherited Members

- Public Attributes inherited from UnifiedAutomation.UaServer.ModelControllerBase
bool HasStatusCodes => m_statusCodes != null && m_statusCodes.Count > 0
 
- Protected Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
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...
 

Detailed Description

Member Enumeration Documentation

The enumeration representing the possible states of the state machine.

Enumerator
Idle 

The Idle state.

ReadPrepare 

The ReadPrepare state.

ReadTransfer 

The ReadTransfer state.

ApplyWrite 

The ApplyWrite state.

Error 

The Error state.

The enumeration representing the possible transitions of the state machine.

Enumerator
ApplyWriteToError 

Transition from State.ApplyWrite to State.Error.

ApplyWriteToIdle 

Transition from State.ApplyWrite to State.Idle.

ErrorToIdle 

Transition from State.Error to State.Idle.

IdleToApplyWrite 

Transition from State.Idle to State.ApplyWrite.

IdleToReadPrepare 

Transition from State.Idle to State.ReadPrepare.

ReadPrepareToError 

Transition from State.ReadPrepare to State.Error.

ReadPrepareToReadTransfer 

Transition from State.ReadPrepare to State.ReadTransfer.

ReadTransferToError 

Transition from State.ReadTransfer to State.Error.

ReadTransferToIdle 

Transition from State.ReadTransfer to State.Idle.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.FileTransferStateMachineModel.FileTransferStateMachineModel ( )

Initializes a new instance of the FileTransferStateMachineModel class.

UnifiedAutomation.UaServer.FileTransferStateMachineModel.FileTransferStateMachineModel ( FileTransferStateMachineModel  template,
DummyArgument  dummy = null 
)

Initializes a new instance of the FileTransferStateMachineModel class.

Parameters
templateThe template.
dummyDummy argument to enable writing own constructors that are called by the generated code.

Member Function Documentation

virtual StatusCode UnifiedAutomation.UaServer.FileTransferStateMachineModel.DispatchMethod ( RequestContext  context,
MethodHandle  methodHandle,
IList< Variant inputArguments,
List< StatusCode inputArgumentResults,
List< Variant outputArguments 
)
virtual

Dispatches the method.

Parameters
contextThe context.
methodHandleThe method handle.
inputArgumentsThe input arguments.
inputArgumentResultsThe input argument results.
outputArgumentsThe output arguments.
Returns
static LocalizedText UnifiedAutomation.UaServer.FileTransferStateMachineModel.GetLocalizedText ( State  state)
static

Retrieves a LocalizedText for the given state value.

Parameters
stateThe state to get the text.
Returns
The text.
static LocalizedText UnifiedAutomation.UaServer.FileTransferStateMachineModel.GetLocalizedText ( Transition  transition)
static

Retrieves a LocalizedText for the given transition value.

Parameters
transitionThe transition to get the text.
Returns
The transition.
virtual CallMethodEventHandler UnifiedAutomation.UaServer.FileTransferStateMachineModel.GetMethodDispatcher ( RequestContext  context,
NodeId  objectId,
NodeId  methodId 
)
virtual

Gets the method dispatcher.

Parameters
contextThe context.
objectIdThe object id.
methodIdThe method id.
Returns

Implements UnifiedAutomation.UaServer.IMethodDispatcher.

static QualifiedName UnifiedAutomation.UaServer.FileTransferStateMachineModel.GetName ( State  state)
static

Retrieves a QualifiedName for the given state value.

Parameters
stateThe state to get the name.
Returns
The name.
static QualifiedName UnifiedAutomation.UaServer.FileTransferStateMachineModel.GetName ( Transition  transition)
static

Retrieves a QualifiedName for the given transition value.

Parameters
transitionThe transition to get the name.
Returns
The name.
static NodeId UnifiedAutomation.UaServer.FileTransferStateMachineModel.GetNodeId ( State  state)
static

Retrieves the NodeId for the given state value.

Parameters
stateThe state to get the NodeId.
Returns
The NodeId.
static NodeId UnifiedAutomation.UaServer.FileTransferStateMachineModel.GetNodeId ( Transition  transition)
static

Retrieves the NodeId for the given transition value.

Parameters
transitionThe transition to get the NodeId.
Returns
The NodeId.
static IEnumerable<Transition> UnifiedAutomation.UaServer.FileTransferStateMachineModel.GetTransitions ( State  oldState,
State  newState 
)
static

A sequence of all possible transition for the given states.

Parameters
oldStateThe From state.
newStateThe 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.FileTransferStateMachineModel.RaiseSwitchedEvent ( State oldState,
State state,
Transition transition 
)

Raises the Switched event.

virtual void UnifiedAutomation.UaServer.FileTransferStateMachineModel.SwitchToState ( State state,
Transition transition = null 
)
virtual

Switch to the given state.

Parameters
stateThe state.
transitionThe 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.

Member Data Documentation

State UnifiedAutomation.UaServer.FileTransferStateMachineModel.m_state
protected

The current state of the state machine.

Transition UnifiedAutomation.UaServer.FileTransferStateMachineModel.m_transition
protected

The last transition of the state machine.

Property Documentation

IFileTransferStateMachineMethods UnifiedAutomation.UaServer.FileTransferStateMachineModel.FileTransferStateMachineMethods
getset

Gets or sets the FileTransferStateMachine methods.

The FileTransferStateMachine methods.

State UnifiedAutomation.UaServer.FileTransferStateMachineModel.InternalState
getprotected set

The FiniteStateMachineModel.CurrentState as the enumeration value.

Transition UnifiedAutomation.UaServer.FileTransferStateMachineModel.InternalTransition
getprotected set

The FiniteStateMachineModel.LastTransition as the enumeration value.

Event Documentation

EventHandler<StateMachineEventArgs<State?, Transition?> > UnifiedAutomation.UaServer.FileTransferStateMachineModel.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: