C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

Wrapper class for the UA stack structure OpcUa_ExpandedNodeId. More...

#include <uaexpandednodeid.h>

Inherits OpcUa_ExpandedNodeId.

Public Member Functions

 UaExpandedNodeId ()
 construction
 
 UaExpandedNodeId (const UaExpandedNodeId &other)
 construction More...
 
 UaExpandedNodeId (const OpcUa_ExpandedNodeId &other)
 construction More...
 
 UaExpandedNodeId (const UaNodeId &id, const UaString &sNsUri, OpcUa_UInt32 serverIndex)
 construction More...
 
 ~UaExpandedNodeId ()
 destruction
 
void clear ()
 Clear the data of the UaExpandedNodeId.
 
void attach (const OpcUa_ExpandedNodeId *pSrc)
 Attaches an existing OpcUa_ExpandedNodeId structure. More...
 
void detach ()
 Reset UaExpandedNodeId structure without clearing the data.
 
UaExpandedNodeIdoperator= (const UaExpandedNodeId &other)
 Copy operator. More...
 
bool operator== (const UaExpandedNodeId &other) const
 Compare variables if they are similar. More...
 
bool operator!= (const UaExpandedNodeId &other) const
 Returns true if other is not equal to this. More...
 
void setExpandedNodeId (const UaNodeId &id, const UaString &sNsUri, OpcUa_UInt32 serverIndex)
 Set the expanded node id. More...
 
 operator const OpcUa_ExpandedNodeId * () const
 Return internal OpcUa_ExpandedNodeId structure. More...
 
OpcUa_ExpandedNodeIdcopy () const
 Copy UaExpandedNodeId data to a newly allocated OpcUa_ExpandedNodeId. More...
 
void copyTo (OpcUa_ExpandedNodeId *pDst) const
 Copy UaExpandedNodeId data to an existing OpcUa_ExpandedNodeId structure. More...
 
UaString toString () const
 Converts the UaExpandedNodeId into a UaString. More...
 
UaString toFullString () const
 Converts an UaExpandedNodeId to a full string. More...
 
UaString toXmlString () const
 Converts an UaExpandedNodeId to a string where the syntax is defined by the OPC UA XML Schema. More...
 
OpcUa_NodeId nodeId () const
 Get the actual node id. More...
 
const OpcUa_StringnamespaceUri () const
 Get the namespace URI. More...
 
OpcUa_UInt32 serverIndex () const
 Get the server index. More...
 

Static Public Member Functions

static bool compare (const OpcUa_ExpandedNodeId &, const OpcUa_ExpandedNodeId &)
 Compare two UaExpandedNodeId variables. More...
 
static OpcUa_ExpandedNodeIdclone (const OpcUa_ExpandedNodeId &source)
 Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes. More...
 
static void cloneTo (const OpcUa_ExpandedNodeId &source, OpcUa_ExpandedNodeId &copy)
 Copy OpcUa_VariableTypeAttributes data to an existing OpcUa_VariableTypeAttributes structure. More...
 
static UaExpandedNodeId fromXmlString (UaString xmlString)
 Creates an ExpandedNodeId from a string where the syntax is defined by the OPC UA XML Schema. More...
 

Friends

UABASE_EXPORT UaDataStream & operator<< (UaDataStream &, const UaExpandedNodeId &)
 Writes a ExpandedNodeId to the stream. More...
 
UABASE_EXPORT UaDataStream & operator>> (UaDataStream &, UaExpandedNodeId &)
 Reads a ExpandedNodeId from the stream. More...
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_ExpandedNodeId.

Constructor & Destructor Documentation

UaExpandedNodeId::UaExpandedNodeId ( const UaExpandedNodeId other)

construction

Parameters
otherthe UaExpandedNodeId.
UaExpandedNodeId::UaExpandedNodeId ( const OpcUa_ExpandedNodeId other)

construction

Parameters
otherthe OpcUa_ExpandedNodeId.
UaExpandedNodeId::UaExpandedNodeId ( const UaNodeId id,
const UaString sNsUri,
OpcUa_UInt32  serverIndex 
)

construction

Parameters
idthe id to set.
sNsUrite namespace URIs.
serverIndexthe server index.

Member Function Documentation

void UaExpandedNodeId::attach ( const OpcUa_ExpandedNodeId pSrc)

Attaches an existing OpcUa_ExpandedNodeId structure.

Don't manually free the attached structure afterwards, because UaExpandedNodeId is responsible for it now.

Parameters
pSrc[in] Parameter to attach.
OpcUa_ExpandedNodeId * UaExpandedNodeId::clone ( const OpcUa_ExpandedNodeId source)
static

Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes.

Parameters
sourceSource to clone.
Returns
new copy.
void UaExpandedNodeId::cloneTo ( const OpcUa_ExpandedNodeId source,
OpcUa_ExpandedNodeId copy 
)
static

Copy OpcUa_VariableTypeAttributes data to an existing OpcUa_VariableTypeAttributes structure.

Parameters
sourceSource OpcUa_VariableTypeAttributes to clone.
copyNew copy of source OpcUa_VariableTypeAttributes.
bool UaExpandedNodeId::compare ( const OpcUa_ExpandedNodeId val1,
const OpcUa_ExpandedNodeId val2 
)
static

Compare two UaExpandedNodeId variables.

Parameters
val1a value as UaExpandedNodeId.
val2a value as UaExpandedNodeId.
Returns
true if equal false if not.
OpcUa_ExpandedNodeId * UaExpandedNodeId::copy ( ) const

Copy UaExpandedNodeId data to a newly allocated OpcUa_ExpandedNodeId.

Returns
a newly allocated OpcUa_ExpandedNodeId.
void UaExpandedNodeId::copyTo ( OpcUa_ExpandedNodeId pDst) const

Copy UaExpandedNodeId data to an existing OpcUa_ExpandedNodeId structure.

Parameters
pDstthe destination of this operation.
UaExpandedNodeId UaExpandedNodeId::fromXmlString ( UaString  xmlString)
static

Creates an ExpandedNodeId from a string where the syntax is defined by the OPC UA XML Schema.

See also
toXmlString()

The string can have one of the following formats
svr=<serverindex>;ns=<namespaceindex>;<type>=<value>
svr=<serverindex>;nsu=<uri>;<type>=<value>

Returns
the ExpandedNodeId created from string or a null ExpandedNodeId if a parsing error occured.
const OpcUa_String* UaExpandedNodeId::namespaceUri ( ) const
inline

Get the namespace URI.

Returns
the namespace URI.
OpcUa_NodeId UaExpandedNodeId::nodeId ( ) const
inline

Get the actual node id.

Returns
the actual node id.
UaExpandedNodeId::operator const OpcUa_ExpandedNodeId * ( ) const

Return internal OpcUa_ExpandedNodeId structure.

Returns
internal OpcUa_ExpandedNodeId structure.
bool UaExpandedNodeId::operator!= ( const UaExpandedNodeId other) const

Returns true if other is not equal to this.

See also
operator==
Parameters
otherthe UaString to compare.
Returns
true if other is not equal to this.
UaExpandedNodeId & UaExpandedNodeId::operator= ( const UaExpandedNodeId other)

Copy operator.

Parameters
otherthe UaExpandedNodeId to assign.
Returns
a copy of this operation.
bool UaExpandedNodeId::operator== ( const UaExpandedNodeId other) const

Compare variables if they are similar.

Parameters
otherthe char to compare.
Returns
true if not similar false if similar.
OpcUa_UInt32 UaExpandedNodeId::serverIndex ( ) const
inline

Get the server index.

Returns
the server index.
void UaExpandedNodeId::setExpandedNodeId ( const UaNodeId id,
const UaString sNsUri,
OpcUa_UInt32  serverIndex 
)

Set the expanded node id.

Parameters
idthe id to set.
sNsUrithe namespace URIs
serverIndexthe server index.
UaString UaExpandedNodeId::toFullString ( ) const

Converts an UaExpandedNodeId to a full string.

Returns
a full string.
UaString UaExpandedNodeId::toString ( ) const

Converts the UaExpandedNodeId into a UaString.

Returns
the converted UaExpandedNodeId.
UaString UaExpandedNodeId::toXmlString ( ) const

Converts an UaExpandedNodeId to a string where the syntax is defined by the OPC UA XML Schema.

See also
fromXmlString()
Returns
the converted ExpandedNodeId.

Friends And Related Function Documentation

UABASE_EXPORT UaDataStream& operator<< ( UaDataStream &  ,
const UaExpandedNodeId  
)
friend

Writes a ExpandedNodeId to the stream.

UABASE_EXPORT UaDataStream& operator>> ( UaDataStream &  ,
UaExpandedNodeId  
)
friend

Reads a ExpandedNodeId from the stream.


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