UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UaBase::BaseNode Class Referenceabstract

Stores the information of BaseNode. More...

#include <basenodes.h>

Inherited by UaBase::Method, UaBase::Object, UaBase::TypeNode, and UaBase::Variable.

Public Member Functions

virtual ~BaseNode ()
 Destruction. More...
 
virtual void setNodeId (const UaNodeId &nodeId)
 Sets the NodeId of the BaseNode. More...
 
UaNodeId nodeId () const
 Returns the NodeId of the BaseNode. More...
 
virtual OpcUa_NodeClass nodeClass () const =0
 Returns the NodeClass of the BaseNode. More...
 
void setBrowseName (const UaQualifiedName &browseName)
 Sets the BrowseName of the BaseNode. More...
 
UaQualifiedName browseName () const
 Returns the BrowseName of the BaseNode. More...
 
void setDisplayName (const UaLocalizedText &displayName)
 Sets the DisplayName of the BaseNode. More...
 
UaLocalizedText displayName () const
 Returns the DisplayName of the BaseNode. More...
 
void setDescription (const UaLocalizedText &description)
 Sets the Description of the BaseNode. More...
 
UaLocalizedText description () const
 Returns the Description of the BaseNode. More...
 
void setWriteMask (OpcUa_UInt32 writeMask)
 Sets the WriteMask of the BaseNode. More...
 
OpcUa_UInt32 writeMask () const
 Returns the WriteMask of the BaseNode. More...
 
void setUserWriteMask (OpcUa_UInt32 userWriteMask)
 Sets the UserWriteMask of the BaseNode. More...
 
OpcUa_UInt32 userWriteMask () const
 Returns the UserWriteMask of the BaseNode. More...
 
void setParentNodeId (const UaNodeId &parentNodeId)
 Sets the NodeId of the parent node of the BaseNode. More...
 
UaNodeId parentNodeId () const
 Returns the NodeId of the parent node. More...
 
virtual void evaluateReferences (const std::map< UaNodeId, BaseNode * > &mapNodes)
 Evaluates the References. More...
 
void parentNode (UaNodeId &rNodeId, UaNodeId &rReferenceTypeId) const
 Returns the NodeId of the node and ReferenceTypeId that references the BaseNode hierarchically. More...
 
void addReference (const Reference &reference)
 Adds the References. More...
 
void removeReference (const Reference &reference)
 Removes the Reference if the Reference can be found. More...
 
void addFullReference (const FullReference &reference)
 Adds the FullReference. More...
 
bool isHierarchicallyReferenced () const
 Returns true if the BaseNode is referenced by a FullReference. More...
 
std::list< BaseNode * > hierarchicallyReferencedNodes () const
 Returns the nodes that are referenced by FullReferences. More...
 
const std::list< Reference > & references () const
 Returns the list of all References. More...
 
void addExtension (const Extension &extension)
 Adds an Extension. More...
 
const std::list< Extension > & extensions () const
 Returns a list of all Extensions. More...
 
const Extensionextension (const UaString &sName) const
 Returns the Extension with the specified name. More...
 
virtual UserDataBaseuserData () const
 Returns the UserDataBase for the BaseNode. More...
 

Protected Member Functions

 BaseNode ()
 Creates a BaseNode. More...
 

Detailed Description

Stores the information of BaseNode.

Implements a default method for accessing UserData from the Extensions. Used by UaNodeSetXmlParser.

Constructor & Destructor Documentation

UaBase::BaseNode::BaseNode ( )
protected

Creates a BaseNode.

WriteMask and UserWriteMask are set to 0.

UaBase::BaseNode::~BaseNode ( )
virtual

Destruction.

Member Function Documentation

void UaBase::BaseNode::addExtension ( const Extension extension)

Adds an Extension.

void UaBase::BaseNode::addFullReference ( const FullReference reference)

Adds the FullReference.

If the FullReference has been already added before, the FullReference will not be added.

void UaBase::BaseNode::addReference ( const Reference reference)

Adds the References.

If the Reference has been already added before, the Reference will not be added.

UaQualifiedName UaBase::BaseNode::browseName ( ) const

Returns the BrowseName of the BaseNode.

UaLocalizedText UaBase::BaseNode::description ( ) const

Returns the Description of the BaseNode.

UaLocalizedText UaBase::BaseNode::displayName ( ) const

Returns the DisplayName of the BaseNode.

void UaBase::BaseNode::evaluateReferences ( const std::map< UaNodeId, BaseNode * > &  mapNodes)
virtual

Evaluates the References.

Creates FullReferences from References. Has to be called when all BaseNodes are created.

Reimplemented in UaBase::TypeNode.

const Extension * UaBase::BaseNode::extension ( const UaString sName) const

Returns the Extension with the specified name.

If the Extension with the name sName cannot be found, is returned.

const std::list< Extension > & UaBase::BaseNode::extensions ( ) const

Returns a list of all Extensions.

std::list< BaseNode * > UaBase::BaseNode::hierarchicallyReferencedNodes ( ) const

Returns the nodes that are referenced by FullReferences.

bool UaBase::BaseNode::isHierarchicallyReferenced ( ) const

Returns true if the BaseNode is referenced by a FullReference.

virtual OpcUa_NodeClass UaBase::BaseNode::nodeClass ( ) const
pure virtual
UaNodeId UaBase::BaseNode::nodeId ( ) const

Returns the NodeId of the BaseNode.

void UaBase::BaseNode::parentNode ( UaNodeId rNodeId,
UaNodeId rReferenceTypeId 
) const

Returns the NodeId of the node and ReferenceTypeId that references the BaseNode hierarchically.

UaNodeId UaBase::BaseNode::parentNodeId ( ) const

Returns the NodeId of the parent node.

const std::list< Reference > & UaBase::BaseNode::references ( ) const

Returns the list of all References.

void UaBase::BaseNode::removeReference ( const Reference reference)

Removes the Reference if the Reference can be found.

void UaBase::BaseNode::setBrowseName ( const UaQualifiedName browseName)

Sets the BrowseName of the BaseNode.

void UaBase::BaseNode::setDescription ( const UaLocalizedText description)

Sets the Description of the BaseNode.

void UaBase::BaseNode::setDisplayName ( const UaLocalizedText displayName)

Sets the DisplayName of the BaseNode.

void UaBase::BaseNode::setNodeId ( const UaNodeId nodeId)
virtual

Sets the NodeId of the BaseNode.

void UaBase::BaseNode::setParentNodeId ( const UaNodeId parentNodeId)

Sets the NodeId of the parent node of the BaseNode.

Setting the parent node is important for creating "type trees", i.e. relations between instances and their children.

void UaBase::BaseNode::setUserWriteMask ( OpcUa_UInt32  userWriteMask)

Sets the UserWriteMask of the BaseNode.

void UaBase::BaseNode::setWriteMask ( OpcUa_UInt32  writeMask)

Sets the WriteMask of the BaseNode.

UserDataBase * UaBase::BaseNode::userData ( ) const
virtual

Returns the UserDataBase for the BaseNode.

This method should be overridden by subclasses. The default implementation creates a BaseNodeStandardUserData from the Extension with the name "UserData".

OpcUa_UInt32 UaBase::BaseNode::userWriteMask ( ) const

Returns the UserWriteMask of the BaseNode.

OpcUa_UInt32 UaBase::BaseNode::writeMask ( ) const

Returns the WriteMask of the BaseNode.


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