Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OpcUa::Node Class Reference

A Node object represent an OPC-UA node. It is high level object intended for developper who want to expose data through OPC-UA or read data from an OPCUA server. Node are usually not create directly but obtained through call to GetRootNode of GetObjectsNode on server or client side. More...

#include <node.h>

Public Member Functions

Node AddFolder (const NodeId &folderId, const QualifiedName &browseName) const
 
Node AddFolder (const std::string &nodeid, const std::string &browseName) const
 
Node AddFolder (uint32_t namespaceidx, const std::string &browseName) const
 
Node AddMethod (const NodeId &variableId, const QualifiedName &browsename, std::function< std::vector< OpcUa::Variant >(NodeId context, std::vector< OpcUa::Variant > arguments)> method) const
 
Node AddMethod (uint32_t namespaceidx, const std::string &BrowseName, std::function< std::vector< OpcUa::Variant >(NodeId context, std::vector< OpcUa::Variant > arguments)> method) const
 
Node AddMethod (const std::string &nodeId, const std::string &browseName, std::function< std::vector< OpcUa::Variant >(NodeId context, std::vector< OpcUa::Variant > arguments)> method) const
 
std::vector< AddNodesResult > AddNodes (std::vector< AddNodesItem > items) const
 
Node AddObject (const NodeId &folderId, const QualifiedName &browseName) const
 
Node AddObject (const std::string &nodeid, const std::string &browseName) const
 
Node AddObject (uint32_t namespaceidx, const std::string &browseName) const
 
Node AddProperty (const NodeId &propertyId, const QualifiedName &browsename, const Variant &val) const
 
Node AddProperty (const std::string &nodeid, const std::string &browseName, const Variant &val) const
 
Node AddProperty (uint32_t namespaceidx, const std::string &browseName, const Variant &val) const
 
std::vector< StatusCode > AddReferences (std::vector< AddReferencesItem > items) const
 
Node AddVariable (const NodeId &variableId, const QualifiedName &browsename, const Variant &val) const
 
Node AddVariable (uint32_t namespaceidx, const std::string &BrowseName, const Variant &val) const
 
Node AddVariable (const std::string &nodeId, const std::string &browseName, const Variant &val) const
 
std::vector< Variant > CallMethod (NodeId methodId, std::vector< Variant > inputArguments) const
 
std::vector< std::vector< Variant > > CallMethods (std::vector< NodeId > methodIds, std::vector< std::vector< Variant >> inputArguments) const
 
VariableAccessLevel GetAccessLevel () const
 
DataValue GetAttribute (const AttributeId attr) const
 
QualifiedName GetBrowseName () const
 
Node GetChild (const std::vector< OpcUa::QualifiedName > &path) const
 
Node GetChild (const std::vector< std::string > &path) const
 
Node GetChild (const std::string &browsename) const
 
std::vector< Node > GetChildren (const OpcUa::ReferenceId &refid) const
 List child nodes by specified reference. More...
 
std::vector< Node > GetChildren () const
 Get ghildren by hierarchal referencies. More...
 
Variant GetDataType () const
 
DataValue GetDataValue () const
 
LocalizedText GetDescription () const
 
NodeId GetId () const
 
NodeClass GetNodeClass () const
 
Node GetParent () const
 
std::vector< Node > GetProperties () const
 
OpcUa::Services::SharedPtr GetServices () const
 
VariableAccessLevel GetUserAccessLevel () const
 
AttributeWriteMask GetUserWriteMask () const
 
Variant GetValue () const
 
std::vector< Node > GetVariables () const
 
AttributeWriteMask GetWriteMask () const
 
bool IsValid () const
 
 Node (Services::SharedPtr srv)
 
 Node (Services::SharedPtr srv, const NodeId &id)
 
 Node (const Node &other)
 
 Node ()
 
bool operator!= (Node const &x) const
 
bool operator== (Node const &x) const
 
void SetAccessLevel (VariableAccessLevel value)
 
void SetAttribute (AttributeId attr, const DataValue &dval) const
 
void SetDescription (const LocalizedText &value)
 
void SetNodeClass (NodeClass value)
 
void SetUserAccessLevel (VariableAccessLevel value)
 
void SetUserWriteMask (AttributeWriteMask value)
 
void SetValue (const Variant &val) const
 
void SetValue (const DataValue &dval) const
 
void SetWriteMask (AttributeWriteMask value)
 
std::string ToString () const
 

Protected Member Functions

void _GetChildren (const OpcUa::ReferenceId &refid, std::vector< Node > &nodes) const
 

Protected Attributes

NodeId Id
 
OpcUa::Services::SharedPtr Server
 

Detailed Description

A Node object represent an OPC-UA node. It is high level object intended for developper who want to expose data through OPC-UA or read data from an OPCUA server. Node are usually not create directly but obtained through call to GetRootNode of GetObjectsNode on server or client side.

Definition at line 42 of file node.h.

Constructor & Destructor Documentation

OpcUa::Node::Node ( Services::SharedPtr  srv)
explicit

Definition at line 33 of file node.cpp.

OpcUa::Node::Node ( Services::SharedPtr  srv,
const NodeId &  id 
)

Definition at line 38 of file node.cpp.

OpcUa::Node::Node ( const Node &  other)

Definition at line 44 of file node.cpp.

OpcUa::Node::Node ( )
inline

Definition at line 49 of file node.h.

Member Function Documentation

void OpcUa::Node::_GetChildren ( const OpcUa::ReferenceId &  refid,
std::vector< Node > &  nodes 
) const
protected

Definition at line 146 of file node.cpp.

Node OpcUa::Node::AddFolder ( const NodeId &  folderId,
const QualifiedName &  browseName 
) const

Definition at line 337 of file node.cpp.

Node OpcUa::Node::AddFolder ( const std::string &  nodeid,
const std::string &  browseName 
) const

Definition at line 323 of file node.cpp.

Node OpcUa::Node::AddFolder ( uint32_t  namespaceidx,
const std::string &  browseName 
) const

Definition at line 330 of file node.cpp.

Node OpcUa::Node::AddMethod ( const NodeId &  variableId,
const QualifiedName &  browsename,
std::function< std::vector< OpcUa::Variant >(NodeId context, std::vector< OpcUa::Variant > arguments)>  method 
) const

Definition at line 519 of file node.cpp.

Node OpcUa::Node::AddMethod ( uint32_t  namespaceidx,
const std::string &  BrowseName,
std::function< std::vector< OpcUa::Variant >(NodeId context, std::vector< OpcUa::Variant > arguments)>  method 
) const

Definition at line 505 of file node.cpp.

Node OpcUa::Node::AddMethod ( const std::string &  nodeId,
const std::string &  browseName,
std::function< std::vector< OpcUa::Variant >(NodeId context, std::vector< OpcUa::Variant > arguments)>  method 
) const

Definition at line 512 of file node.cpp.

std::vector< AddNodesResult > OpcUa::Node::AddNodes ( std::vector< AddNodesItem >  items) const

Definition at line 239 of file node.cpp.

Node OpcUa::Node::AddObject ( const NodeId &  folderId,
const QualifiedName &  browseName 
) const

Definition at line 377 of file node.cpp.

Node OpcUa::Node::AddObject ( const std::string &  nodeid,
const std::string &  browseName 
) const

Definition at line 362 of file node.cpp.

Node OpcUa::Node::AddObject ( uint32_t  namespaceidx,
const std::string &  browseName 
) const

Definition at line 369 of file node.cpp.

Node OpcUa::Node::AddProperty ( const NodeId &  propertyId,
const QualifiedName &  browsename,
const Variant &  val 
) const

Definition at line 469 of file node.cpp.

Node OpcUa::Node::AddProperty ( const std::string &  nodeid,
const std::string &  browseName,
const Variant &  val 
) const

Definition at line 462 of file node.cpp.

Node OpcUa::Node::AddProperty ( uint32_t  namespaceidx,
const std::string &  browseName,
const Variant &  val 
) const

Definition at line 455 of file node.cpp.

std::vector< StatusCode > OpcUa::Node::AddReferences ( std::vector< AddReferencesItem >  items) const

Definition at line 244 of file node.cpp.

Node OpcUa::Node::AddVariable ( const NodeId &  variableId,
const QualifiedName &  browsename,
const Variant &  val 
) const

Definition at line 416 of file node.cpp.

Node OpcUa::Node::AddVariable ( uint32_t  namespaceidx,
const std::string &  BrowseName,
const Variant &  val 
) const

Definition at line 402 of file node.cpp.

Node OpcUa::Node::AddVariable ( const std::string &  nodeId,
const std::string &  browseName,
const Variant &  val 
) const

Definition at line 409 of file node.cpp.

std::vector< Variant > OpcUa::Node::CallMethod ( NodeId  methodId,
std::vector< Variant >  inputArguments 
) const

Definition at line 80 of file node.cpp.

std::vector< std::vector< Variant > > OpcUa::Node::CallMethods ( std::vector< NodeId >  methodIds,
std::vector< std::vector< Variant >>  inputArguments 
) const

Definition at line 93 of file node.cpp.

VariableAccessLevel OpcUa::Node::GetAccessLevel ( ) const
inline

Definition at line 101 of file node.h.

DataValue OpcUa::Node::GetAttribute ( const AttributeId  attr) const

Definition at line 55 of file node.cpp.

QualifiedName OpcUa::Node::GetBrowseName ( ) const

Definition at line 227 of file node.cpp.

Node OpcUa::Node::GetChild ( const std::vector< OpcUa::QualifiedName > &  path) const

Definition at line 270 of file node.cpp.

Node OpcUa::Node::GetChild ( const std::vector< std::string > &  path) const

Definition at line 254 of file node.cpp.

Node OpcUa::Node::GetChild ( const std::string &  browsename) const

Definition at line 249 of file node.cpp.

std::vector< Node > OpcUa::Node::GetChildren ( const OpcUa::ReferenceId &  refid) const

List child nodes by specified reference.

Returns
zero or more child nodes.

Definition at line 215 of file node.cpp.

std::vector< Node > OpcUa::Node::GetChildren ( ) const

Get ghildren by hierarchal referencies.

Returns
One or zero chilren nodes.

Definition at line 222 of file node.cpp.

Variant OpcUa::Node::GetDataType ( ) const

Definition at line 558 of file node.cpp.

DataValue OpcUa::Node::GetDataValue ( ) const

Definition at line 553 of file node.cpp.

LocalizedText OpcUa::Node::GetDescription ( ) const
inline

Definition at line 103 of file node.h.

NodeId OpcUa::Node::GetId ( ) const

Definition at line 50 of file node.cpp.

NodeClass OpcUa::Node::GetNodeClass ( ) const
inline

Definition at line 105 of file node.h.

Node OpcUa::Node::GetParent ( ) const

Definition at line 183 of file node.cpp.

std::vector< Node > OpcUa::Node::GetProperties ( ) const

Definition at line 296 of file node.cpp.

OpcUa::Services::SharedPtr OpcUa::Node::GetServices ( ) const
inline

Definition at line 157 of file node.h.

VariableAccessLevel OpcUa::Node::GetUserAccessLevel ( ) const
inline

Definition at line 107 of file node.h.

AttributeWriteMask OpcUa::Node::GetUserWriteMask ( ) const
inline

Definition at line 109 of file node.h.

Variant OpcUa::Node::GetValue ( ) const

Definition at line 548 of file node.cpp.

std::vector<Node> OpcUa::Node::GetVariables ( ) const
inline

Definition at line 76 of file node.h.

AttributeWriteMask OpcUa::Node::GetWriteMask ( ) const
inline

Definition at line 111 of file node.h.

bool OpcUa::Node::IsValid ( ) const
inline

Definition at line 78 of file node.h.

bool OpcUa::Node::operator!= ( Node const &  x) const
inline

Definition at line 154 of file node.h.

bool OpcUa::Node::operator== ( Node const &  x) const
inline

Definition at line 153 of file node.h.

void OpcUa::Node::SetAccessLevel ( VariableAccessLevel  value)
inline

Definition at line 100 of file node.h.

void OpcUa::Node::SetAttribute ( AttributeId  attr,
const DataValue &  dval 
) const

Definition at line 125 of file node.cpp.

void OpcUa::Node::SetDescription ( const LocalizedText &  value)
inline

Definition at line 102 of file node.h.

void OpcUa::Node::SetNodeClass ( NodeClass  value)
inline

Definition at line 104 of file node.h.

void OpcUa::Node::SetUserAccessLevel ( VariableAccessLevel  value)
inline

Definition at line 106 of file node.h.

void OpcUa::Node::SetUserWriteMask ( AttributeWriteMask  value)
inline

Definition at line 108 of file node.h.

void OpcUa::Node::SetValue ( const Variant &  val) const

Definition at line 135 of file node.cpp.

void OpcUa::Node::SetValue ( const DataValue &  dval) const

Definition at line 141 of file node.cpp.

void OpcUa::Node::SetWriteMask ( AttributeWriteMask  value)
inline

Definition at line 110 of file node.h.

std::string OpcUa::Node::ToString ( ) const

Definition at line 316 of file node.cpp.

Member Data Documentation

NodeId OpcUa::Node::Id
protected

Definition at line 166 of file node.h.

OpcUa::Services::SharedPtr OpcUa::Node::Server
protected

Definition at line 165 of file node.h.

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

ros_opcua_impl_freeopcua
Author(s): Denis Štogl
autogenerated on Tue Jan 19 2021 03:12:09