Generated base class for a ProgramStateMachineType. More...

#include <opcua_programstatemachinetypebase.h>

Inherited by OpcUa::ProgramStateMachineType.

Public Member Functions
	ProgramStateMachineTypeBase (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an ProgramStateMachineType object using an instance declaration node as base.

	ProgramStateMachineTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an ProgramStateMachineType object.

	ProgramStateMachineTypeBase (UaBase::Object pBaseNode, XmlUaNodeFactoryManager pFactory, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an instance of the class ProgramStateMachineTypeBase with all components. More...

virtual UaNodeId	typeDefinitionId () const
	Returns the type definition NodeId for the ProgramStateMachineType.

virtual UaStatus	beginCall (MethodManagerCallback pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle pMethodHandle, const UaVariantArray &inputArguments)
	Call method of an UA object. More...

virtual UaStatus	call (const ServiceContext &serviceContext, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments, UaVariantArray &outputArguments, UaStatusCodeArray &inputArgumentResults, UaDiagnosticInfos &inputArgumentDiag)
	Synchronous version of the MethodManager method call executed in a worker thread.

virtual UaStatus	baseHalt (const ServiceContext &serviceContext)=0
	Method used to to halt a program. More...

virtual UaStatus	baseReset (const ServiceContext &serviceContext)=0
	Method used to to reset a program. More...

virtual UaStatus	baseResume (const ServiceContext &serviceContext)=0
	Method used to to resume a program. More...

virtual UaStatus	baseStart (const ServiceContext &serviceContext)=0
	Method used to to start a program. More...

virtual UaStatus	baseSuspend (const ServiceContext &serviceContext)=0
	Method used to to suspend a program. More...

virtual void	setDeletable (OpcUa_Boolean Deletable)
	Sets the Deletable value.

virtual OpcUa_Boolean	getDeletable () const
	Returns the value of Deletable.

virtual void	setProgramDiagnostics (const UaProgramDiagnosticDataType &ProgramDiagnostics)
	Sets the ProgramDiagnostics value. More...

virtual UaProgramDiagnosticDataType	getProgramDiagnostics () const
	Returns the value of ProgramDiagnostics. More...

virtual void	setRecycleCount (OpcUa_Int32 RecycleCount)
	Sets the RecycleCount value.

virtual OpcUa_Int32	getRecycleCount () const
	Returns the value of RecycleCount.

virtual OpcUa::PropertyType *	getDeletableNode ()
	Returns the Deletable node.

virtual const OpcUa::PropertyType *	getDeletableNode () const
	Returns the Deletable node.

virtual OpcUa::BaseObjectType *	getFinalResultData ()
	Returns the FinalResultData node. More...

virtual const OpcUa::BaseObjectType *	getFinalResultData () const
	Returns the FinalResultData node. More...

virtual OpcUa::ProgramDiagnosticType *	getProgramDiagnosticsNode ()
	Returns the ProgramDiagnostics node. More...

virtual const OpcUa::ProgramDiagnosticType *	getProgramDiagnosticsNode () const
	Returns the ProgramDiagnostics node. More...

virtual OpcUa::PropertyType *	getRecycleCountNode ()
	Returns the RecycleCount node.

virtual const OpcUa::PropertyType *	getRecycleCountNode () const
	Returns the RecycleCount node.

virtual OpcUa::BaseMethod *	getHalt ()
	Returns the Halt node.

virtual const OpcUa::BaseMethod *	getHalt () const
	Returns the Halt node.

virtual OpcUa::BaseMethod *	getReset ()
	Returns the Reset node.

virtual const OpcUa::BaseMethod *	getReset () const
	Returns the Reset node.

virtual OpcUa::BaseMethod *	getResume ()
	Returns the Resume node.

virtual const OpcUa::BaseMethod *	getResume () const
	Returns the Resume node.

virtual OpcUa::BaseMethod *	getStart ()
	Returns the Start node.

virtual const OpcUa::BaseMethod *	getStart () const
	Returns the Start node.

virtual OpcUa::BaseMethod *	getSuspend ()
	Returns the Suspend node.

virtual const OpcUa::BaseMethod *	getSuspend () const
	Returns the Suspend node.

virtual void	useAccessInfoFromType ()
	Applies the NodeAccessInfo set at the ProgramStateMachineTypeBase and its children. More...

void	useAccessInfoFromInstance (ProgramStateMachineTypeBase *pInstance)
	Uses the NodeAccessInfo of pOther and its children. More...

Public Member Functions inherited from OpcUa::FiniteStateMachineType
	FiniteStateMachineType (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the class FiniteStateMachineType. More...

	FiniteStateMachineType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Construction of the class FiniteStateMachineType. More...

	FiniteStateMachineType (UaBase::Object pBaseNode, XmlUaNodeFactoryManager pFactory, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an instance of the class FiniteStateMachineType with all components. More...

virtual void	setCurrentState (const UaLocalizedText &currentState)
	Sets the CurrentState. More...

virtual UaLocalizedText	getCurrentState (Session *pSession)
	Gets the CurrentState. More...

virtual void	setLastTransition (const UaLocalizedText &lastTransition)
	Sets the LastTransition. More...

virtual UaLocalizedText	getLastTransition (Session *pSession)
	Gets the LastTransition. More...

virtual OpcUa::FiniteStateVariableType *	getCurrentStateNode ()
	Returns the CurrentState node. More...

virtual OpcUa::FiniteTransitionVariableType *	getLastTransitionNode ()
	Returns the LastTransition node. More...

void	useAccessInfoFromInstance (FiniteStateMachineType *pInstance)
	Uses the NodeAccessInfo of pOther and its children. More...

Public Member Functions inherited from OpcUa::BaseObjectType
	BaseObjectType (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the class BaseObjectType. More...

	BaseObjectType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Construction of the class BaseObjectType. More...

UaReferenceLists *	getUaReferenceLists () const
	Get the UaReferenceLists interface for the node. More...

virtual UaStatus	browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
	Discover the references of a specified node of a view. More...

UaNodeId	nodeId () const
	Get the NodeId of the current Node. More...

virtual UaQualifiedName	browseName () const
	Get the browseName of the current Node. More...

virtual UaLocalizedText	displayName (Session *pSession) const
	Get the displayName as LocalizedText of the current Node. More...

virtual OpcUa_Boolean	isDescriptionSupported () const
	Check if Node is DescriptionSupported. More...

virtual UaLocalizedText	description (Session *pSession) const
	Get the description as LocalizedText of the current Node. More...

virtual OpcUa_Boolean	isWriteMaskSupported () const
	Check if Node is WriteMaskSupported. More...

virtual OpcUa_UInt32	writeMask () const
	Get the writeMask of the current Node. More...

virtual OpcUa_Boolean	isUserWriteMaskSupported () const
	Check if Node is UserWriteMaskSupported. More...

virtual OpcUa_UInt32	userWriteMask (Session *pSession) const
	Check if Node has a userWriteMask. More...

UaNode *	getUaNode () const
	Get the UaNode interface pointer of this node. More...

virtual OpcUa_Byte	eventNotifier () const
	Returns the EventNotifier for the BaseObjectType. More...

virtual MethodManager *	getMethodManager (UaMethod *pMethod) const
	Returns the method manager interface for the BaseObjectType instance. More...

virtual void	setUserData (UserDataBase *pUserData)
	Method to set user data stored in this class. More...

virtual UserDataBase *	getUserData () const
	Method to get the user data stored in this class. More...

virtual void	setBrowseName (const UaQualifiedName &browseName)
	Sets the browse name attribute value. More...

virtual void	setDisplayName (const UaLocalizedText &displayName)
	Sets the display name attribute value. More...

virtual void	setDescription (const UaLocalizedText &description)
	Sets the description attribute value. More...

virtual void	setWriteMask (OpcUa_UInt32 writeMask)
	Sets the write mask attribute value. More...

virtual void	setEventNotifier (OpcUa_Byte eventNotifier)
	Sets the eventNotifier attribute value. More...

virtual void	setModellingRuleId (const UaNodeId &modellingRuleId)
	Set NodeId of the modeling rule for this node. More...

virtual UaNodeId	modellingRuleId () const
	Get NodeId of the modeling rule for this node. More...

void	setMethodManager (MethodManager *pMethodManager)
	Allows a class aggregating the object to implement the MethodManager for this object. More...

virtual UaStatus	setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, OpcUa_Boolean checkWriteMask)
	Sets the value of an attribute of the Node. More...

Public Member Functions inherited from MethodManager
	MethodManager ()
	construction

virtual	~MethodManager ()
	destruction

Public Member Functions inherited from UaObject
	UaObject ()
	Construction of the UaObject. More...

OpcUa_NodeClass	nodeClass () const
	Get the node class of the Node. More...

virtual void	getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, UaDataValue &uaDataValue)
	Gets the value of an attribute of the Node. More...

Public Member Functions inherited from UaNode
	UaNode ()
	Construction of the UaNode. More...

virtual UaNodeId	getKey () const
	Get the key of the node used for the hash table. More...

const NodeAccessInfo *	getAccessInfo () const
	Returns the access info for this node. More...

void	useAccessInfoFrom (const UaNode *pOther)
	Set the NodeAccessInfo from another node to this node. More...

void	setAccessInfo (NodeAccessInfo *pAccessInfo)
	Set the NodeAccessInfo for this node. More...

void	attachAccessInfo (NodeAccessInfo *pAccessInfo)
	Set the NodeAccessInfo for this node. More...

Public Member Functions inherited from ChainEntry
	ChainEntry ()
	construction

ChainEntry *	find (const UaNodeId &key, ChainEntry **ppPrevious)
	finds the right entry in the chain. More...

void	add (ChainEntry *pNewEntry)
	adds a new entry to the list. More...

void	prepend (ChainEntry *pNewEntry)
	prepends a new entry to the list. More...

ChainEntry *	remove (const UaNodeId &key, ChainEntry **ppNext)
	removes an entry from the list. More...

ChainEntry *	getNext () const
	Check if there is a chain. More...

virtual void	setInvalid ()
	Set the entry to invalid. More...

void	clearChain ()
	Clear the chain when the hashtable is cleared.

Public Member Functions inherited from ReferenceCounter
	ReferenceCounter ()
	construction

virtual	~ReferenceCounter ()
	destruction

Public Member Functions inherited from UaReferenceLists
	UaReferenceLists ()
	Constructs the reference lists object.

virtual	~UaReferenceLists ()
	Destroys the reference lists object.

virtual UaStatus	browseReferences (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
	Discover the references of a specified node of a view. More...

virtual UaStatus	translateBrowsePathToNodeId (const ServiceContext &serviceContext, const UaNodeId &startingNode, UaRelativePath &relativePath, UaBrowsePathTargets &browsePathTargets)
	Find a node based on an element of an relative path. More...

virtual const UaReference *	pTargetNodes () const
	Returns the list of references to target nodes. More...

virtual const UaReference *	pSourceNodes () const
	Returns the list of references to source nodes. More...

virtual UaNode *	getTargetNodeByBrowseName (const UaQualifiedName &browseName) const
	Searches a target node with the passed browse name and returns the UaNode interface if found. More...

virtual void	addTargetNode (UaReference *pReference)
	Add a reference to a target node where this node is the source node. More...

virtual void	addSourceNode (UaReference *pReference)
	Adds a reference to a source node where this node is the target node. More...

virtual UaStatus	removeSourceNode (UaReference *pReferenceToRemove)
	Remove a reference to a source node where this node is the target node. More...

virtual bool	removeSourceReference (UaReference *pReferenceToRemove)
	Remove the passed reference to a source node. More...

virtual UaStatus	removeTargetNode (UaNode *pTargetNode, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
	Remove a reference to a target node where this node is the source node. More...

virtual UaStatus	removeTargetNode (const UaNodeId &targetNodeId, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
	Remove a reference to a target node where this node is the source node. More...

virtual bool	removeTargetReference (UaReference *pReferenceToRemove)
	Remove the passed reference to a target node. More...

virtual UaStatus	removeCrossNodeManagerRef (NodeManager *pNodeManager)
	Remove references to another NodeManager. More...

virtual UaStatus	invalidateSourceReferences (OpcUa_Boolean deleteSourceReferences)
	Set all references from SourceNodes to this Node invalid. More...

virtual UaStatus	invalidateTargetReferences (OpcUa_Boolean deleteTargetReferences)
	Set all references to TargetNode of this node invalid. More...

virtual UaStatus	deleteAllChildren (NodeManagerConfig *pNodeManagerConfig)
	Deletes all child nodes. More...

Static Public Member Functions
static void	createTypes ()
	Create the related type nodes.

static void	clearStaticMembers ()
	Clear the static members of the class.

Static Public Member Functions inherited from OpcUa::FiniteStateMachineType
static void	createTypes ()
	Create the related type nodes.

static void	clearStaticMembers ()
	Clear the static members of the class.

Static Public Member Functions inherited from OpcUa::BaseObjectType
static void	clearStaticMembers ()
	Clear the static members of the class.

Protected Member Functions
virtual	~ProgramStateMachineTypeBase ()
	Destruction.

Protected Member Functions inherited from OpcUa::FiniteStateMachineType
virtual	~FiniteStateMachineType ()
	Destruction.

Protected Member Functions inherited from OpcUa::BaseObjectType
virtual	~BaseObjectType ()
	Destruction of the BaseObjectType. More...

Protected Member Functions inherited from UaObject
virtual	~UaObject ()
	Destruction of the UaObject. More...

Protected Member Functions inherited from UaNode
virtual	~UaNode ()
	Destruction of the UaNode. More...

Protected Member Functions inherited from ChainEntry
virtual	~ChainEntry ()
	destruction

Additional Inherited Members
Protected Attributes inherited from UaReferenceLists
UaReference *	m_pTargetNodes
	List of references to target nodes where this node is the source node. More...

UaReference *	m_pLastTargetNode
	Last references in the list of references to the target nodes. More...

UaReference *	m_pSourceNodes
	List of references to source nodes where this node is the target node. More...

Detailed Description

Generated base class for a ProgramStateMachineType.

This class contains the generated base code for the object type ProgramStateMachineType representing an OPC UA ObjectType. This class is used to create the object type and to create and represent instances of the object type in the server address space.

Object members of the ProgramStateMachineType:

Browse Name	TypeDefinition	Modelling Rule	See Also
FinalResultData	BaseObjectType	Optional	getFinalResultData
Halted	StateType	None
HaltedToReady	TransitionType	None
Ready	StateType	None
ReadyToHalted	TransitionType	None
ReadyToRunning	TransitionType	None
Running	StateType	None
RunningToHalted	TransitionType	None
RunningToReady	TransitionType	None
RunningToSuspended	TransitionType	None
Suspended	StateType	None
SuspendedToHalted	TransitionType	None
SuspendedToReady	TransitionType	None
SuspendedToRunning	TransitionType	None

Variable members of the ProgramStateMachineType:

Browse Name	DataType	TypeDefinition	Modelling Rule	See Also
AutoDelete	Boolean	PropertyType	MandatoryShared
Creatable	Boolean	PropertyType	None
Deletable	Boolean	PropertyType	Mandatory	getDeletable, setDeletable
InstanceCount	UInt32	PropertyType	None
MaxInstanceCount	UInt32	PropertyType	None
MaxRecycleCount	UInt32	PropertyType	None
ProgramDiagnostics	ProgramDiagnosticDataType	ProgramDiagnosticType	Optional	getProgramDiagnostics, setProgramDiagnostics
RecycleCount	Int32	PropertyType	Mandatory	getRecycleCount, setRecycleCount

Constructor & Destructor Documentation

OpcUa::ProgramStateMachineTypeBase::ProgramStateMachineTypeBase	(	UaBase::Object *	pBaseNode,
		XmlUaNodeFactoryManager *	pFactory,
		NodeManagerConfig *	pNodeConfig,
		UaMutexRefCounted *	pSharedMutex = `NULL`
	)

Constructs an instance of the class ProgramStateMachineTypeBase with all components.

Parameters

[in]	pBaseNode	The "tree" of nodes that specifies the attributes of the instance and its children
[in]	pFactory	The factory to create the children
[in]	pNodeConfig	Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]	pSharedMutex	Shared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided

Member Function Documentation

virtual UaStatus OpcUa::ProgramStateMachineTypeBase::baseHalt ( const ServiceContext & serviceContext )

pure virtual

Method used to to halt a program.

Causes the Program to transition from the Ready, Running or Suspended state to the Halted state.

The method name prefix 'base' is used to avoid naming conflicts if derived types override the methods to add arguments.

Parameters

serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::ProgramStateMachineType.

virtual UaStatus OpcUa::ProgramStateMachineTypeBase::baseReset ( const ServiceContext & serviceContext )

pure virtual

Method used to to reset a program.

Causes the Program to transition from the Halted state to the Ready state.

The method name prefix 'base' is used to avoid naming conflicts if derived types override the methods to add arguments.

Parameters

serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::ProgramStateMachineType.

virtual UaStatus OpcUa::ProgramStateMachineTypeBase::baseResume ( const ServiceContext & serviceContext )

pure virtual

Method used to to resume a program.

Causes the Program to transition from the Suspended state to the Running state.

The method name prefix 'base' is used to avoid naming conflicts if derived types override the methods to add arguments.

Parameters

serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::ProgramStateMachineType.

virtual UaStatus OpcUa::ProgramStateMachineTypeBase::baseStart ( const ServiceContext & serviceContext )

pure virtual

Method used to to start a program.

Causes the Program to transition from the Ready state to the Running state.

The method name prefix 'base' is used to avoid naming conflicts if derived types override the methods to add arguments.

Parameters

serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::ProgramStateMachineType.

virtual UaStatus OpcUa::ProgramStateMachineTypeBase::baseSuspend ( const ServiceContext & serviceContext )

pure virtual

Method used to to suspend a program.

Causes the Program to transition from the Running state to the Suspended state.

The method name prefix 'base' is used to avoid naming conflicts if derived types override the methods to add arguments.

Parameters

serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::ProgramStateMachineType.

UaStatus OpcUa::ProgramStateMachineTypeBase::beginCall	(	MethodManagerCallback *	pCallback,
		const ServiceContext &	serviceContext,
		OpcUa_UInt32	callbackHandle,
		MethodHandle *	pMethodHandle,
		const UaVariantArray &	inputArguments
	)

virtual

Call method of an UA object.

Implementation of the MethodManager interface method beginCall.

Reimplemented from OpcUa::BaseObjectType.

OpcUa::BaseObjectType * OpcUa::ProgramStateMachineTypeBase::getFinalResultData ( )

virtual

Returns the FinalResultData node.

If the Object has not been created yet, this method creates the node and returns it.

const OpcUa::BaseObjectType * OpcUa::ProgramStateMachineTypeBase::getFinalResultData ( ) const

virtual

Returns the FinalResultData node.

If the Object has not been created yet, this method return NULL.

UaProgramDiagnosticDataType OpcUa::ProgramStateMachineTypeBase::getProgramDiagnostics ( ) const

virtual

Returns the value of ProgramDiagnostics.

If the optional ProgramDiagnostics node has not been created, the value of the InstanceDeclaration node of the ObjectType is returned.

OpcUa::ProgramDiagnosticType * OpcUa::ProgramStateMachineTypeBase::getProgramDiagnosticsNode ( )

virtual

Returns the ProgramDiagnostics node.

If the Variable has not been created yet, this method returns NULL.

const OpcUa::ProgramDiagnosticType * OpcUa::ProgramStateMachineTypeBase::getProgramDiagnosticsNode ( ) const

virtual

Returns the ProgramDiagnostics node.

If the Variable has not been created yet, this method returns NULL.

void OpcUa::ProgramStateMachineTypeBase::setProgramDiagnostics ( const UaProgramDiagnosticDataType & ProgramDiagnostics )

virtual

Sets the ProgramDiagnostics value.

If the optional ProgramDiagnostics node has not been created, this method adds it to the address space.

void OpcUa::ProgramStateMachineTypeBase::useAccessInfoFromInstance ( ProgramStateMachineTypeBase * pOther )

Uses the NodeAccessInfo of pOther and its children.

void OpcUa::ProgramStateMachineTypeBase::useAccessInfoFromType ( )

virtual

Applies the NodeAccessInfo set at the ProgramStateMachineTypeBase and its children.

Reimplemented from OpcUa::FiniteStateMachineType.

The documentation for this class was generated from the following files:

C:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_programstatemachinetypebase.h
C:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_programstatemachinetypebase.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation