OpcUaDi::BlockTypeBase Class Reference

Generated base class for a BlockType. More...

#include <opcuadi_blocktypebase.h>

Inherits OpcUaDi::TopologyElementType.

Inherited by OpcUaDi::BlockType.

Public Member Functions
	BlockTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an BlockType object using an instance declaration node as base.
	BlockTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an BlockType object.
	BlockTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an instance of the class BlockTypeBase with all components. More...
virtual UaNodeId	typeDefinitionId () const
	Returns the type definition NodeId for the BlockType.
virtual void	setActualMode (const UaLocalizedText &ActualMode)
	Sets the ActualMode value. More...
virtual UaLocalizedText	getActualMode (Session *pSession) const
	Returns the value of ActualMode. More...
virtual void	setNormalMode (const UaLocalizedTextArray &NormalMode)
	Sets the NormalMode. More...
virtual void	getNormalMode (UaLocalizedTextArray &NormalMode) const
	Gets the NormalMode. More...
virtual void	setPermittedMode (const UaLocalizedTextArray &PermittedMode)
	Sets the PermittedMode. More...
virtual void	getPermittedMode (UaLocalizedTextArray &PermittedMode) const
	Gets the PermittedMode. More...
virtual void	setRevisionCounter (OpcUa_UInt32 RevisionCounter)
	Sets the RevisionCounter value. More...
virtual OpcUa_UInt32	getRevisionCounter () const
	Returns the value of RevisionCounter. More...
virtual void	setTargetMode (const UaLocalizedTextArray &TargetMode)
	Sets the TargetMode. More...
virtual void	getTargetMode (UaLocalizedTextArray &TargetMode) const
	Gets the TargetMode. More...
virtual OpcUa::PropertyType *	getActualModeNode ()
	Returns the ActualMode node. More...
virtual OpcUa::PropertyType *	getNormalModeNode ()
	Returns the NormalMode node. More...
virtual OpcUa::PropertyType *	getPermittedModeNode ()
	Returns the PermittedMode node. More...
virtual OpcUa::PropertyType *	getRevisionCounterNode ()
	Returns the RevisionCounter node. More...
virtual OpcUa::PropertyType *	getTargetModeNode ()
	Returns the TargetMode node. More...
virtual void	useAccessInfoFromType ()
	Applies the NodeAccessInfo set at the BlockTypeBase and its children. More...
void	useAccessInfoFromInstance (BlockTypeBase *pInstance)
	Uses the NodeAccessInfo of pOther and its children. More...
Public Member Functions inherited from OpcUaDi::TopologyElementType
	TopologyElementType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the class TopologyElementType. More...
	TopologyElementType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the class TopologyElementType. More...
	TopologyElementType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an instance of the class TopologyElementType with all components. More...
UaStatus	createParameterSet ()
	Creates the optional ParameterSet object if not available.
Public Member Functions inherited from OpcUaDi::TopologyElementTypeBase
	TopologyElementTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an TopologyElementType object using an instance declaration node as base.
	TopologyElementTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an TopologyElementType object.
	TopologyElementTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an instance of the class TopologyElementTypeBase with all components. More...
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 OpcUaDi::FunctionalGroupType *	getIdentification ()
	Returns the Identification node. More...
virtual OpcUaDi::LockingServicesType *	getLock ()
	Returns the Lock node. More...
virtual OpcUa::BaseObjectType *	getMethodSet ()
	Returns the MethodSet node. More...
virtual OpcUa::BaseObjectType *	getParameterSet ()
	Returns the ParameterSet node. More...
virtual UaStatus	addGroup (OpcUaDi::FunctionalGroupType *pGroup)
	Adds the passed FunctionalGroupType node by creating an HasComponent reference.
virtual UaStatus	addParameterSet_Parameter (OpcUa::BaseDataVariableType *pParameter)
	Adds the passed BaseDataVariableType node to the ParameterSet node by creating an HasComponent reference.
virtual UaStatus	addMethodSet_Method (OpcUa::BaseMethod *pMethod)
	Adds the passed Method node to the MethodSet node by creating an HasComponent reference.
void	useAccessInfoFromInstance (TopologyElementTypeBase *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 OpcUaDi::TopologyElementType
static void	createTypes ()
	Create the type related static members of the class.
static void	clearStaticMembers ()
	Clear the static members of the class.
Static Public Member Functions inherited from OpcUaDi::TopologyElementTypeBase
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	~BlockTypeBase ()
	Destruction.
Protected Member Functions inherited from OpcUaDi::TopologyElementType
virtual	~TopologyElementType ()
	Destruction.
Protected Member Functions inherited from OpcUaDi::TopologyElementTypeBase
virtual	~TopologyElementTypeBase ()
	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 BlockType.

This class contains the generated base code for the object type BlockType 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.

Variable members of the BlockType:

Browse Name	DataType	TypeDefinition	Modelling Rule	See Also
ActualMode	LocalizedText	PropertyType	Optional	getActualMode, setActualMode
NormalMode	LocalizedText	PropertyType	Optional	getNormalMode, setNormalMode
PermittedMode	LocalizedText	PropertyType	Optional	getPermittedMode, setPermittedMode
RevisionCounter	UInt32	PropertyType	Optional	getRevisionCounter, setRevisionCounter
TargetMode	LocalizedText	PropertyType	Optional	getTargetMode, setTargetMode

Constructor & Destructor Documentation

OpcUaDi::BlockTypeBase::BlockTypeBase	(	UaBase::Object *	pBaseNode,
		XmlUaNodeFactoryManager *	pFactory,
		NodeManagerConfig *	pNodeConfig,
		UaMutexRefCounted *	pSharedMutex = NULL
	)

Constructs an instance of the class BlockTypeBase 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

UaLocalizedText OpcUaDi::BlockTypeBase::getActualMode ( Session *  pSession ) const

virtual

Returns the value of ActualMode.

Current mode of operation the Block is able to achieve

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

OpcUa::PropertyType * OpcUaDi::BlockTypeBase::getActualModeNode ( )

virtual

Returns the ActualMode node.

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

void OpcUaDi::BlockTypeBase::getNormalMode ( UaLocalizedTextArray &  NormalMode ) const

virtual

Gets the NormalMode.

Mode the Block should be set to during normal operating conditions

OpcUa::PropertyType * OpcUaDi::BlockTypeBase::getNormalModeNode ( )

virtual

Returns the NormalMode node.

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

void OpcUaDi::BlockTypeBase::getPermittedMode ( UaLocalizedTextArray &  PermittedMode ) const

virtual

Gets the PermittedMode.

Modes of operation that are allowed for the Block based on application requirements

OpcUa::PropertyType * OpcUaDi::BlockTypeBase::getPermittedModeNode ( )

virtual

Returns the PermittedMode node.

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

OpcUa_UInt32 OpcUaDi::BlockTypeBase::getRevisionCounter ( ) const

virtual

Returns the value of RevisionCounter.

Incremental counter indicating the number of times the static data within the Block has been modified

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

OpcUa::PropertyType * OpcUaDi::BlockTypeBase::getRevisionCounterNode ( )

virtual

Returns the RevisionCounter node.

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

void OpcUaDi::BlockTypeBase::getTargetMode ( UaLocalizedTextArray &  TargetMode ) const

virtual

Gets the TargetMode.

Mode of operation that is desired for the Block

OpcUa::PropertyType * OpcUaDi::BlockTypeBase::getTargetModeNode ( )

virtual

Returns the TargetMode node.

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

void OpcUaDi::BlockTypeBase::setActualMode ( const UaLocalizedText &  ActualMode )

virtual

Sets the ActualMode value.

Current mode of operation the Block is able to achieve

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

void OpcUaDi::BlockTypeBase::setNormalMode ( const UaLocalizedTextArray &  NormalMode )

virtual

Sets the NormalMode.

Mode the Block should be set to during normal operating conditions

void OpcUaDi::BlockTypeBase::setPermittedMode ( const UaLocalizedTextArray &  PermittedMode )

virtual

Sets the PermittedMode.

Modes of operation that are allowed for the Block based on application requirements

void OpcUaDi::BlockTypeBase::setRevisionCounter ( OpcUa_UInt32  RevisionCounter )

virtual

Sets the RevisionCounter value.

Incremental counter indicating the number of times the static data within the Block has been modified

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

void OpcUaDi::BlockTypeBase::setTargetMode ( const UaLocalizedTextArray &  TargetMode )

virtual

Sets the TargetMode.

Mode of operation that is desired for the Block

void OpcUaDi::BlockTypeBase::useAccessInfoFromInstance

(

BlockTypeBase *

pOther

)

Uses the NodeAccessInfo of pOther and its children.

void OpcUaDi::BlockTypeBase::useAccessInfoFromType ( )

virtual

Applies the NodeAccessInfo set at the BlockTypeBase and its children.

Reimplemented from OpcUaDi::TopologyElementTypeBase.

Reimplemented in OpcUaPlc::CtrlFunctionBlockTypeBase, OpcUaPlc::CtrlProgramOrganizationUnitTypeBase, and OpcUaPlc::CtrlProgramTypeBase.

---

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

• C:/work/uasdkcpp/src/uaserver/uaservercpp/uamodels/opcuadi_blocktypebase.h
• C:/work/uasdkcpp/src/uaserver/uaservercpp/uamodels/opcuadi_blocktypebase.cpp