com.prosysopc.ua.types.opcua.server
Class ProgramStateMachineTypeNodeBase

java.lang.Object
  extended by com.prosysopc.ua.nodes.AbstractUaNode
      extended by com.prosysopc.ua.server.nodes.ServerNode
          extended by com.prosysopc.ua.server.nodes.BaseNode
              extended by com.prosysopc.ua.server.nodes.UaInstanceNode
                  extended by com.prosysopc.ua.server.nodes.UaObjectNode
                      extended by com.prosysopc.ua.server.nodes.AbstractGeneratedObjectNode
                          extended by com.prosysopc.ua.types.opcua.server.BaseObjectTypeNode
                              extended by com.prosysopc.ua.types.opcua.server.StateMachineTypeNodeBase
                                  extended by com.prosysopc.ua.types.opcua.server.StateMachineTypeNode
                                      extended by com.prosysopc.ua.types.opcua.server.FiniteStateMachineTypeNodeBase
                                          extended by com.prosysopc.ua.types.opcua.server.FiniteStateMachineTypeNode
                                              extended by com.prosysopc.ua.types.opcua.server.ProgramStateMachineTypeNodeBase
All Implemented Interfaces:
UaInstance, UaNode, UaObject, GeneratedNode, UaCallable, BaseInstanceType, BaseObjectType, FiniteStateMachineType, ProgramStateMachineType, StateMachineType
Direct Known Subclasses:
ProgramStateMachineTypeNode

public abstract class ProgramStateMachineTypeNodeBase
extends FiniteStateMachineTypeNode
implements ProgramStateMachineType

A state machine for a program.

Generated on 2018-05-09 10:46:24


Field Summary
 
Fields inherited from class com.prosysopc.ua.server.nodes.BaseNode
NODE_VERSION_PROPERTY_NAME
 
Fields inherited from class com.prosysopc.ua.server.nodes.ServerNode
eventListeners, INITIALIZATION_TIME, nodeManager, supportedAttributesMap
 
Fields inherited from interface com.prosysopc.ua.types.opcua.ProgramStateMachineType
AUTO_DELETE, CURRENT_STATE, DELETABLE, FINAL_RESULT_DATA, HALT, LAST_TRANSITION, PROGRAM_DIAGNOSTICS, RECYCLE_COUNT, RESET, RESUME, START, SUSPEND
 
Constructor Summary
protected ProgramStateMachineTypeNodeBase(NodeManagerUaNode nodeManager, org.opcfoundation.ua.builtintypes.NodeId nodeId, org.opcfoundation.ua.builtintypes.QualifiedName browseName, org.opcfoundation.ua.builtintypes.LocalizedText displayName)
           
 
Method Summary
 void afterCreate()
          This method is called after NodeBuilder has constructed the instance, it is called for every sub-node that also implement this interface
 org.opcfoundation.ua.builtintypes.Variant[] callMethod(ServiceContext serviceContext, org.opcfoundation.ua.builtintypes.NodeId methodId, org.opcfoundation.ua.builtintypes.Variant[] inputArguments, org.opcfoundation.ua.builtintypes.StatusCode[] inputArgumentResults, org.opcfoundation.ua.builtintypes.DiagnosticInfo[] inputArgumentDiagnosticInfos)
          Fallback implementation when no subtype handles the method call.
 UaProperty getAutoDeleteNode()
           
 org.opcfoundation.ua.builtintypes.LocalizedText getCurrentState()
           
 FiniteStateVariableTypeNode getCurrentStateNode()
           
 UaProperty getDeletableNode()
           
 BaseObjectTypeNode getFinalResultDataNode()
           
static ProgramStateMachineTypeHaltMethod getHaltMethodImplementation()
           
 UaMethod getHaltNode()
           
 org.opcfoundation.ua.builtintypes.LocalizedText getLastTransition()
           
 FiniteTransitionVariableTypeNode getLastTransitionNode()
           
 org.opcfoundation.ua.core.ProgramDiagnosticDataType getProgramDiagnostics()
           
 ProgramDiagnosticTypeNode getProgramDiagnosticsNode()
           
static GeneratedNodeInitializer<ProgramStateMachineTypeNode> getProgramStateMachineTypeNodeInitializer()
           
 Integer getRecycleCount()
           
 UaProperty getRecycleCountNode()
           
static ProgramStateMachineTypeResetMethod getResetMethodImplementation()
           
 UaMethod getResetNode()
           
static ProgramStateMachineTypeResumeMethod getResumeMethodImplementation()
           
 UaMethod getResumeNode()
           
static ProgramStateMachineTypeStartMethod getStartMethodImplementation()
           
 UaMethod getStartNode()
           
static ProgramStateMachineTypeSuspendMethod getSuspendMethodImplementation()
           
 UaMethod getSuspendNode()
           
 void halt()
           
 Boolean isAutoDelete()
           
 Boolean isDeletable()
           
protected abstract  void onHalt(ServiceContext serviceContext)
           
protected abstract  void onReset(ServiceContext serviceContext)
           
protected abstract  void onResume(ServiceContext serviceContext)
           
protected abstract  void onStart(ServiceContext serviceContext)
           
protected abstract  void onSuspend(ServiceContext serviceContext)
           
 void reset()
           
 void resume()
           
 void setAutoDelete(Boolean value)
           
 void setCurrentState(org.opcfoundation.ua.builtintypes.LocalizedText value)
           
 void setDeletable(Boolean value)
           
static void setHaltMethodImplementation(ProgramStateMachineTypeHaltMethod haltMethodImplementationNewValue)
           
 void setLastTransition(org.opcfoundation.ua.builtintypes.LocalizedText value)
           
 void setProgramDiagnostics(org.opcfoundation.ua.core.ProgramDiagnosticDataType value)
           
static void setProgramStateMachineTypeNodeInitializer(GeneratedNodeInitializer<ProgramStateMachineTypeNode> programStateMachineTypeNodeInitializerNewValue)
           
 void setRecycleCount(Integer value)
           
static void setResetMethodImplementation(ProgramStateMachineTypeResetMethod resetMethodImplementationNewValue)
           
static void setResumeMethodImplementation(ProgramStateMachineTypeResumeMethod resumeMethodImplementationNewValue)
           
static void setStartMethodImplementation(ProgramStateMachineTypeStartMethod startMethodImplementationNewValue)
           
static void setSuspendMethodImplementation(ProgramStateMachineTypeSuspendMethod suspendMethodImplementationNewValue)
           
 void start()
           
 void suspend()
           
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.FiniteStateMachineTypeNodeBase
getFiniteStateMachineTypeNodeInitializer, setFiniteStateMachineTypeNodeInitializer
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.StateMachineTypeNodeBase
getStateMachineTypeNodeInitializer, setStateMachineTypeNodeInitializer
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.BaseObjectTypeNode
isCacheMethodIds, setCacheMethodIds
 
Methods inherited from class com.prosysopc.ua.server.nodes.AbstractGeneratedObjectNode
afterCreateInitIfExists, afterCreateSetValueIfExists, callAfterCreateIfExists, getDefaultTypeDefinition, getQualifiedName, isComponentMatch
 
Methods inherited from class com.prosysopc.ua.server.nodes.UaObjectNode
addCallListener, callMethod, deleteIfNodeExists, getAttributes, getAttributes, getEventNotifier, getIcon, getNodeClass, initSupportedAttributes, readAttributeValue, removeCallListener, setAttributes, setEventNotifier, setIcon, toString, writeAttributeValue
 
Methods inherited from class com.prosysopc.ua.server.nodes.UaInstanceNode
addModellingRule, beforeAddReference, getTypeDefinition, getTypeDefinitionId, hasTypeDefinition, registerOverridePlainMethod, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId, supportsTypeDefinitionNode
 
Methods inherited from class com.prosysopc.ua.server.nodes.BaseNode
addPlainProperty, addPlainVariable, assertTypeSupport, assertTypeSupport, createNodeId, createNodeId, createReflectiveInstanceProperty, createReflectiveInstanceProperty, deleteReference, deleteReference, doAddProperty, getAttributes, getBrowseName, getComponent, getComponents, getDescription, getDescription, getDisplayName, getDisplayName, getMethod, getNodeVersion, getNodeVersionValue, getProperties, getProperty, getPropertyValue, getReferencesAsList, getStandardBrowseName, getStandardDisplayText, getUserWriteMask, getWriteMask, hasProperty, hasReference, hasUserWriteAccess, hasWriteAccess, incNodeVersion, initNodeVersion, isChildOfType, readAttribute, readAttribute, registerCallbackProperty, registerPlainInstanceProperty, registerPlainInstanceProperty, registerPlainProperty, registerPlainProperty, registerPlainVariable, registerPlainVariable, registerReflectiveInstanceProperty, registerReflectiveInstanceVariable, registerReflectiveProperty, registerReflectiveVariable, removeProperty, setAccessLevelRecursively, setAccessLevelRecursively, setAttribute, setBrowseName, setDescription, setDisplayName, setNodeVersionValue, setPropertyValue, setUserWriteMask, setWriteMask, writeAttribute
 
Methods inherited from class com.prosysopc.ua.server.nodes.ServerNode
addComponent, addDataChangeListener, addEventListener, addNewReference, addNewReference, addOrganizes, addProperties, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, afterAddReference, afterDeleteReference, dataChange, deleteReference, deleteReference, deleteReferences, doDeleteReference, equals, findPlaceholders, fireDataChange, fireEvent, fireEventInParents, getAddressSpace, getDefaultBrowseName, getNodeId, getNodeManager, getReference, getReferenceList, getReferences, getSupportedAttributes, getTargetNodes, hashCode, isAddNotifierReferencesToServerObject, isFalseOrNull, isMandatory, isMonitoredForEvents, isTrueOrNull, isType, referenceTypeInherits, removeComponent, removeDataChangeListener, removeEventListener, setAddNotifierReferencesToServerObject, setReferences, supportsAttribute, translateBrowsePathToNodeIds, validateHasEventSourceChain, validateHasEventSourceChain
 
Methods inherited from class com.prosysopc.ua.nodes.AbstractUaNode
getForwardReferences, getInverseReferences, getReferences, getReferences, referenceTypeInherits
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.prosysopc.ua.types.opcua.BaseInstanceType
getQualifiedName
 
Methods inherited from interface com.prosysopc.ua.nodes.UaObject
callMethod, getEventNotifier, getIcon, setEventNotifier, setIcon
 
Methods inherited from interface com.prosysopc.ua.nodes.UaInstance
getTypeDefinition, getTypeDefinitionId, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId
 
Methods inherited from interface com.prosysopc.ua.nodes.UaNode
addComponent, addProperty, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributes, getBrowseName, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeClass, getNodeId, getNodeVersion, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute
 

Constructor Detail

ProgramStateMachineTypeNodeBase

protected ProgramStateMachineTypeNodeBase(NodeManagerUaNode nodeManager,
                                          org.opcfoundation.ua.builtintypes.NodeId nodeId,
                                          org.opcfoundation.ua.builtintypes.QualifiedName browseName,
                                          org.opcfoundation.ua.builtintypes.LocalizedText displayName)
Method Detail

afterCreate

public void afterCreate()
Description copied from interface: GeneratedNode
This method is called after NodeBuilder has constructed the instance, it is called for every sub-node that also implement this interface

Specified by:
afterCreate in interface GeneratedNode
Overrides:
afterCreate in class FiniteStateMachineTypeNode

getProgramStateMachineTypeNodeInitializer

public static GeneratedNodeInitializer<ProgramStateMachineTypeNode> getProgramStateMachineTypeNodeInitializer()

setProgramStateMachineTypeNodeInitializer

public static void setProgramStateMachineTypeNodeInitializer(GeneratedNodeInitializer<ProgramStateMachineTypeNode> programStateMachineTypeNodeInitializerNewValue)

getDeletableNode

public UaProperty getDeletableNode()
Specified by:
getDeletableNode in interface ProgramStateMachineType

isDeletable

public Boolean isDeletable()
Specified by:
isDeletable in interface ProgramStateMachineType

setDeletable

public void setDeletable(Boolean value)
Specified by:
setDeletable in interface ProgramStateMachineType

getAutoDeleteNode

public UaProperty getAutoDeleteNode()
Specified by:
getAutoDeleteNode in interface ProgramStateMachineType

isAutoDelete

public Boolean isAutoDelete()
Specified by:
isAutoDelete in interface ProgramStateMachineType

setAutoDelete

public void setAutoDelete(Boolean value)
Specified by:
setAutoDelete in interface ProgramStateMachineType

getRecycleCountNode

public UaProperty getRecycleCountNode()
Specified by:
getRecycleCountNode in interface ProgramStateMachineType

getRecycleCount

public Integer getRecycleCount()
Specified by:
getRecycleCount in interface ProgramStateMachineType

setRecycleCount

public void setRecycleCount(Integer value)
Specified by:
setRecycleCount in interface ProgramStateMachineType

getCurrentStateNode

public FiniteStateVariableTypeNode getCurrentStateNode()
Specified by:
getCurrentStateNode in interface FiniteStateMachineType
Specified by:
getCurrentStateNode in interface ProgramStateMachineType
Specified by:
getCurrentStateNode in interface StateMachineType
Overrides:
getCurrentStateNode in class FiniteStateMachineTypeNodeBase

getCurrentState

public org.opcfoundation.ua.builtintypes.LocalizedText getCurrentState()
Specified by:
getCurrentState in interface FiniteStateMachineType
Specified by:
getCurrentState in interface ProgramStateMachineType
Specified by:
getCurrentState in interface StateMachineType
Overrides:
getCurrentState in class FiniteStateMachineTypeNodeBase

setCurrentState

public void setCurrentState(org.opcfoundation.ua.builtintypes.LocalizedText value)
Specified by:
setCurrentState in interface FiniteStateMachineType
Specified by:
setCurrentState in interface ProgramStateMachineType
Specified by:
setCurrentState in interface StateMachineType
Overrides:
setCurrentState in class FiniteStateMachineTypeNodeBase

getLastTransitionNode

public FiniteTransitionVariableTypeNode getLastTransitionNode()
Specified by:
getLastTransitionNode in interface FiniteStateMachineType
Specified by:
getLastTransitionNode in interface ProgramStateMachineType
Specified by:
getLastTransitionNode in interface StateMachineType
Overrides:
getLastTransitionNode in class FiniteStateMachineTypeNodeBase

getLastTransition

public org.opcfoundation.ua.builtintypes.LocalizedText getLastTransition()
Specified by:
getLastTransition in interface FiniteStateMachineType
Specified by:
getLastTransition in interface ProgramStateMachineType
Specified by:
getLastTransition in interface StateMachineType
Overrides:
getLastTransition in class FiniteStateMachineTypeNodeBase

setLastTransition

public void setLastTransition(org.opcfoundation.ua.builtintypes.LocalizedText value)
Specified by:
setLastTransition in interface FiniteStateMachineType
Specified by:
setLastTransition in interface ProgramStateMachineType
Specified by:
setLastTransition in interface StateMachineType
Overrides:
setLastTransition in class FiniteStateMachineTypeNodeBase

getProgramDiagnosticsNode

public ProgramDiagnosticTypeNode getProgramDiagnosticsNode()
Specified by:
getProgramDiagnosticsNode in interface ProgramStateMachineType

getProgramDiagnostics

public org.opcfoundation.ua.core.ProgramDiagnosticDataType getProgramDiagnostics()
Specified by:
getProgramDiagnostics in interface ProgramStateMachineType

setProgramDiagnostics

public void setProgramDiagnostics(org.opcfoundation.ua.core.ProgramDiagnosticDataType value)
Specified by:
setProgramDiagnostics in interface ProgramStateMachineType

getFinalResultDataNode

public BaseObjectTypeNode getFinalResultDataNode()
Specified by:
getFinalResultDataNode in interface ProgramStateMachineType

callMethod

public org.opcfoundation.ua.builtintypes.Variant[] callMethod(ServiceContext serviceContext,
                                                              org.opcfoundation.ua.builtintypes.NodeId methodId,
                                                              org.opcfoundation.ua.builtintypes.Variant[] inputArguments,
                                                              org.opcfoundation.ua.builtintypes.StatusCode[] inputArgumentResults,
                                                              org.opcfoundation.ua.builtintypes.DiagnosticInfo[] inputArgumentDiagnosticInfos)
                                                       throws StatusException
Description copied from class: UaObjectNode
Fallback implementation when no subtype handles the method call.

Specified by:
callMethod in interface UaCallable
Overrides:
callMethod in class FiniteStateMachineTypeNodeBase
Returns:
Throws:
StatusException

getStartNode

public UaMethod getStartNode()
Specified by:
getStartNode in interface ProgramStateMachineType

onStart

protected abstract void onStart(ServiceContext serviceContext)
                         throws StatusException
Throws:
StatusException

start

public void start()
           throws StatusException
Specified by:
start in interface ProgramStateMachineType
Throws:
StatusException

getStartMethodImplementation

public static ProgramStateMachineTypeStartMethod getStartMethodImplementation()

setStartMethodImplementation

public static void setStartMethodImplementation(ProgramStateMachineTypeStartMethod startMethodImplementationNewValue)

getSuspendNode

public UaMethod getSuspendNode()
Specified by:
getSuspendNode in interface ProgramStateMachineType

onSuspend

protected abstract void onSuspend(ServiceContext serviceContext)
                           throws StatusException
Throws:
StatusException

suspend

public void suspend()
             throws StatusException
Specified by:
suspend in interface ProgramStateMachineType
Throws:
StatusException

getSuspendMethodImplementation

public static ProgramStateMachineTypeSuspendMethod getSuspendMethodImplementation()

setSuspendMethodImplementation

public static void setSuspendMethodImplementation(ProgramStateMachineTypeSuspendMethod suspendMethodImplementationNewValue)

getResumeNode

public UaMethod getResumeNode()
Specified by:
getResumeNode in interface ProgramStateMachineType

onResume

protected abstract void onResume(ServiceContext serviceContext)
                          throws StatusException
Throws:
StatusException

resume

public void resume()
            throws StatusException
Specified by:
resume in interface ProgramStateMachineType
Throws:
StatusException

getResumeMethodImplementation

public static ProgramStateMachineTypeResumeMethod getResumeMethodImplementation()

setResumeMethodImplementation

public static void setResumeMethodImplementation(ProgramStateMachineTypeResumeMethod resumeMethodImplementationNewValue)

getHaltNode

public UaMethod getHaltNode()
Specified by:
getHaltNode in interface ProgramStateMachineType

onHalt

protected abstract void onHalt(ServiceContext serviceContext)
                        throws StatusException
Throws:
StatusException

halt

public void halt()
          throws StatusException
Specified by:
halt in interface ProgramStateMachineType
Throws:
StatusException

getHaltMethodImplementation

public static ProgramStateMachineTypeHaltMethod getHaltMethodImplementation()

setHaltMethodImplementation

public static void setHaltMethodImplementation(ProgramStateMachineTypeHaltMethod haltMethodImplementationNewValue)

getResetNode

public UaMethod getResetNode()
Specified by:
getResetNode in interface ProgramStateMachineType

onReset

protected abstract void onReset(ServiceContext serviceContext)
                         throws StatusException
Throws:
StatusException

reset

public void reset()
           throws StatusException
Specified by:
reset in interface ProgramStateMachineType
Throws:
StatusException

getResetMethodImplementation

public static ProgramStateMachineTypeResetMethod getResetMethodImplementation()

setResetMethodImplementation

public static void setResetMethodImplementation(ProgramStateMachineTypeResetMethod resetMethodImplementationNewValue)


Copyright © 2018. All rights reserved.