C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
UaPropertyMethodArgument Class Reference

UaPropertyMethodArgument. More...

#include <uadatavariablecache.h>

Inherits UaVariableCache, and UaReferenceLists.

Public Types

enum  ArgumentType { INARGUMENTS, OUTARGUMENTS }
 ArgumentType enumeration. More...
 

Public Member Functions

 UaPropertyMethodArgument (const UaNodeId &nodeId, OpcUa_UInt32 accessLevel, OpcUa_UInt32 numberOfArguments, ArgumentType argumentType, UaMutexRefCounted *pSharedMutex=NULL)
 construction
 
UaReferenceListsgetUaReferenceLists () const
 Get a ReferenceList where all the Nodes are in. More...
 
UaStatus browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
virtual UaNodeId typeDefinitionId () const
 Get the object type NodeId for the server object. More...
 
UaNodeId nodeId () const
 Get the NodeId for the DataVariable. More...
 
virtual UaQualifiedName browseName () const
 Get the browseName as QualifiedName 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
 Get the WriteMask of the User. More...
 
virtual UaDataValue value (Session *pSession)
 Sets the current value for the DataVariable. More...
 
virtual UaStatus setValue (Session *pSession, const UaDataValue &dataValue, OpcUa_Boolean checkAccessLevel)
 Sets the current value for the DataVariable. More...
 
virtual UaNodeId dataType () const
 Get the DataType for the DataVariable. More...
 
virtual OpcUa_Int32 valueRank () const
 Get the ValueRank for the DataVariable. More...
 
virtual OpcUa_Boolean isArrayDimensionsSupported () const
 Check if the Node is ArrayDimensionsSupported. More...
 
virtual void arrayDimensions (UaUInt32Array &arrayDimensions) const
 Get the arrayDimensions value for the passed UaNode. More...
 
virtual OpcUa_UInt32 accessLevel () const
 Get the AccessLevel for the DataVariable. More...
 
virtual OpcUa_Byte userAccessLevel (Session *pSession) const
 Get the UserAccessLevel for the DataVariable. More...
 
virtual OpcUa_Boolean isMinimumSamplingIntervalSupported () const
 Check whether a minimum sampling interval is supported. More...
 
virtual OpcUa_Double minimumSamplingInterval () const
 Get the minimum sampling interval of the Node. More...
 
virtual OpcUa_Boolean historizing () const
 Indicates if historizing is available or not. More...
 
UaNodegetUaNode () const
 Get the Node. More...
 
OpcUa_StatusCode setArgument (OpcUa_UInt32 index, const UaString &name, const UaNodeId &dataType, OpcUa_Int32 valueRank, const UaUInt32Array &arrayDimensions, const UaLocalizedText &description)
 Set one of the arguments in the argument list. More...
 
- Public Member Functions inherited from UaVariableCache
 UaVariableCache (UaMutexRefCounted *pSharedMutex=NULL)
 Constructes a cache variable with default settings using the passed shared mutex.
 
virtual OpcUa_UInt32 valueHandling () const
 Get the mode for the handling of the value attribute. More...
 
void addCacheSignal (CacheSignal *pCacheSignal)
 Add a cache item. More...
 
void removeCacheSignal (CacheSignal *pCacheSignal)
 Remove a cache item. More...
 
void signalChange ()
 Signal change to all cache items.
 
OpcUa_UInt32 signalCount ()
 Get the count of connected monitored items. More...
 
OpcUa_UInt32 getMinSamplingInterval ()
 Get the minimum sampling interval requested. More...
 
VariableHandlepVariableHandle ()
 Return the VariableHandle for the DataVariable. More...
 
virtual void setInvalid ()
 Set the variable to invalid. More...
 
virtual void setSharedMutex (UaMutexRefCounted *pSharedMutex)
 Set a shared mutex used for multiple variables. More...
 
void getHandleIOVariableList (std::list< OpcUa_UInt32 > &handles)
 Returns a list of IOManager handles for the connected IOVariable CacheSignals. More...
 
- Public Member Functions inherited from UaVariable
 UaVariable (UaMutexRefCounted *pSharedMutex=NULL)
 construction
 
virtual void setValueHandling (OpcUa_UInt32 valueHandling)
 Set the mode for the handling of the value attribute. More...
 
OpcUa_NodeClass nodeClass () const
 Get the NodeClass of the current Node. More...
 
virtual UaStatus setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, NodeAccessInfo *pDefaultPermissions, OpcUa_Boolean checkWriteMask)
 Sets the value of an attribute of the Node. More...
 
virtual void getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, NodeAccessInfo *pDefaultPermissions, UaDataValue &uaDataValue)
 Gets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from UaNode
 UaNode (UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the UaNode. More...
 
virtual UaNodeId getKey () const
 Get the key of the node used for the hash table. More...
 
virtual UaNodeId modellingRuleId () const
 Get NodeId of the modeling rule for this node. More...
 
virtual void setUserData (UserDataBase *pUserData)
 Defines the method to set user data handled by a derived class. More...
 
virtual UserDataBasegetUserData () const
 Returns user data provided by a derived class. More...
 
virtual NodeAccessInfogetAccessInfo () const
 Returns the access info for this node. More...
 
virtual bool hasAccessInfo () const
 Check if this UaNode has a NodeAccessInfo assigned. More...
 
virtual void useAccessInfoFrom (const UaNode *pOther)
 Set the NodeAccessInfo from another node to this node. More...
 
virtual void setAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
virtual void attachAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
- Public Member Functions inherited from ChainEntry
 ChainEntry ()
 construction
 
ChainEntryfind (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...
 
ChainEntryremove (const UaNodeId &key, ChainEntry **ppNext)
 removes an entry from the list. More...
 
ChainEntrygetNext () const
 Check if there is a chain. 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 UaReferencepTargetNodes () const
 Returns the list of references to target nodes. More...
 
virtual const UaReferencepSourceNodes () const
 Returns the list of references to source nodes. More...
 
virtual UaNodegetTargetNodeByBrowseName (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...
 

Protected Member Functions

virtual ~UaPropertyMethodArgument ()
 destruction
 
- Protected Member Functions inherited from UaVariableCache
virtual ~UaVariableCache ()
 Destroyes the cache variable object.
 
- Protected Member Functions inherited from UaVariable
virtual ~UaVariable ()
 destruction
 
- Protected Member Functions inherited from UaNode
virtual ~UaNode ()
 Destruction of the UaNode. More...
 
- Protected Member Functions inherited from ChainEntry
virtual ~ChainEntry ()
 destruction
 
- Protected Member Functions inherited from UaReferenceLists
virtual UaStatus collectAllChildrenRecursive (NodeManagerConfig *pNodeManagerConfig, NodesToDeleteCollection &nodesToDeleteCollection, int recursionCounter=0)
 Collect a list of all child nodes. More...
 

Additional Inherited Members

- Protected Attributes inherited from UaReferenceLists
UaReferencem_pTargetNodes
 List of references to target nodes where this node is the source node. More...
 
UaReferencem_pLastTargetNode
 Last references in the list of references to the target nodes. More...
 
UaReferencem_pSourceNodes
 List of references to source nodes where this node is the target node. More...
 

Detailed Description

UaPropertyMethodArgument.

Class definition of the UaPropertyMethodArgument. Derived from UaVariableCache and UaReferenceLists. It is not possible to use the default constructor.

Member Enumeration Documentation

ArgumentType enumeration.

Enumerator
INARGUMENTS 

Inargument

OUTARGUMENTS 

Outargument

Member Function Documentation

OpcUa_UInt32 UaPropertyMethodArgument::accessLevel ( ) const
virtual

Get the AccessLevel for the DataVariable.

Returns
the AccessLevel for the DataVariable.

Implements UaVariable.

void UaPropertyMethodArgument::arrayDimensions ( UaUInt32Array arrayDimensions) const
virtual

Get the arrayDimensions value for the passed UaNode.

Parameters
arrayDimensionsthe arrayDimensions value for the passed UaNode.

Implements UaVariable.

UaStatus UaPropertyMethodArgument::browse ( const ServiceContext serviceContext,
BrowseContext browseContext,
UaReferenceDescriptions References 
)
virtual

Discover the references of a specified node of a view.

This method is used to return a list of references and target nodes for the passed node to browse for the services Browse and BrowseNext.

Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
browseContextBrowse context for the first browse or the following browse with continuation point.
ReferencesArray of ReferenceDescription results for the browsed node.
Returns
Error code

Implements UaNode.

UaQualifiedName UaPropertyMethodArgument::browseName ( ) const
virtual

Get the browseName as QualifiedName of the current Node.

Returns
the BrowseName for the DataVariable as QualifiedName.

Implements UaNode.

UaNodeId UaPropertyMethodArgument::dataType ( ) const
virtual

Get the DataType for the DataVariable.

Returns
the DataType for the DataVariable.

Implements UaVariable.

UaLocalizedText UaPropertyMethodArgument::description ( Session pSession) const
virtual

Get the description as LocalizedText of the current Node.

Parameters
pSessionInterface to the Session context for the method call
Returns
the LocalizedText of the current Node.

Implements UaNode.

UaLocalizedText UaPropertyMethodArgument::displayName ( Session pSession) const
virtual

Get the displayName as LocalizedText of the current Node.

Parameters
pSessionInterface to the Session context for the method call
Returns
the LocalizedText of the current Node.

Implements UaNode.

UaNode* UaPropertyMethodArgument::getUaNode ( ) const
inlinevirtual

Get the Node.

Returns
the current searched Node.

Implements UaReferenceLists.

UaReferenceLists* UaPropertyMethodArgument::getUaReferenceLists ( ) const
inlinevirtual

Get a ReferenceList where all the Nodes are in.

Returns
a ReferenceList where all the Nodes are in.

Reimplemented from UaNode.

OpcUa_Boolean UaPropertyMethodArgument::historizing ( ) const
virtual

Indicates if historizing is available or not.

Returns
TRUE if historizing is available FALSE if not.

Implements UaVariable.

OpcUa_Boolean UaPropertyMethodArgument::isArrayDimensionsSupported ( ) const
virtual

Check if the Node is ArrayDimensionsSupported.

Returns
FALSE if not supported.

Implements UaVariable.

OpcUa_Boolean UaPropertyMethodArgument::isDescriptionSupported ( ) const
virtual

Check if Node is DescriptionSupported.

Returns
FALSE if not supported.

Implements UaNode.

OpcUa_Boolean UaPropertyMethodArgument::isMinimumSamplingIntervalSupported ( ) const
virtual

Check whether a minimum sampling interval is supported.

Returns
TRUE if supported FALSE if not.

Implements UaVariable.

OpcUa_Boolean UaPropertyMethodArgument::isUserWriteMaskSupported ( ) const
virtual

Check if Node is UserWriteMaskSupported.

Returns
TRUE if Node is UserWriteMaskSupported.

Implements UaNode.

OpcUa_Boolean UaPropertyMethodArgument::isWriteMaskSupported ( ) const
virtual

Check if Node is WriteMaskSupported.

Returns
TRUE if Node is WriteMaskSupported.

Implements UaNode.

OpcUa_Double UaPropertyMethodArgument::minimumSamplingInterval ( ) const
virtual

Get the minimum sampling interval of the Node.

Returns
the minimum sampling interval.

Implements UaVariable.

UaNodeId UaPropertyMethodArgument::nodeId ( ) const
virtual

Get the NodeId for the DataVariable.

Returns
the NodeId for the DataVariable.

Implements UaNode.

OpcUa_StatusCode UaPropertyMethodArgument::setArgument ( OpcUa_UInt32  index,
const UaString name,
const UaNodeId dataType,
OpcUa_Int32  valueRank,
const UaUInt32Array arrayDimensions,
const UaLocalizedText description 
)

Set one of the arguments in the argument list.

Parameters
indexthe index where the new item is stored.
namethe name of the new item.
dataTypethe DataType of the DataVariable.
valueRankthe ValueRank of the DataVariable.
arrayDimensionsthe arrayDimensions value for the passed UaNode.
descriptionthe description as LocalizedText of the current Node.
Returns
Error code
UaStatus UaPropertyMethodArgument::setValue ( Session pSession,
const UaDataValue dataValue,
OpcUa_Boolean  checkAccessLevel 
)
virtual

Sets the current value for the DataVariable.

Parameters
pSessionInterface to the Session context for the method call
dataValueCached value of the DataVariable.
checkAccessLevelchecks the Access Level of the current Session.
Returns
Error code

Implements UaVariable.

UaNodeId UaPropertyMethodArgument::typeDefinitionId ( ) const
virtual

Get the object type NodeId for the server object.

Returns
the object type NodeId for the server object.

Reimplemented from UaNode.

OpcUa_Byte UaPropertyMethodArgument::userAccessLevel ( Session pSession) const
virtual

Get the UserAccessLevel for the DataVariable.

Parameters
pSessionInterface to the Session context for the method call
Returns
the UserAccessLevel for the DataVariable.

Implements UaVariable.

OpcUa_UInt32 UaPropertyMethodArgument::userWriteMask ( Session pSession) const
virtual

Get the WriteMask of the User.

Parameters
pSessionInterface to the Session context for the method call
Returns
the WriteMask of the User.

Implements UaNode.

UaDataValue UaPropertyMethodArgument::value ( Session pSession)
virtual

Sets the current value for the DataVariable.

Parameters
pSessionInterface to the Session context for the method call
Returns
the current value for the DataVariable.

Implements UaVariable.

OpcUa_Int32 UaPropertyMethodArgument::valueRank ( ) const
virtual

Get the ValueRank for the DataVariable.

Returns
the ValueRank for the DataVariable.

Implements UaVariable.

OpcUa_UInt32 UaPropertyMethodArgument::writeMask ( ) const
virtual

Get the writeMask of the current Node.

Returns
the writeMask.

Implements UaNode.


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