Typedefs | |
typedef void * | CVOPCNODE |
Handle of an OPCUA Node object. More... | |
Functions | |
CVOPCNODE | CreateCVOPCMethod (cvbuint16_t NameSpaceIndex, const char *Name, CVOPCNODEID Parent) |
Creates an OPCUA Method Node with the specified parameter. More... | |
CVOPCNODE | CreateCVOPCMethodW (cvbuint16_t NameSpaceIndex, const wchar_t *Name, CVOPCNODEID Parent) |
Creates an OPCUA Method Node with the specified parameter. More... | |
CVOPCNODE | CreateCVOPCObject (cvbuint16_t NameSpaceIndex, const char *Name, CVOPCNODEID Parent) |
Creates an OPCUA Object with the specified parameter. More... | |
CVOPCNODE | CreateCVOPCObjectFromType (cvbuint16_t NameSpaceIndex, const char *Name, CVOPCNODEID Parent, CVOPCNODEID TypeDefinition) |
Creates an OPCUA Object with the specified parameter and the type definition. More... | |
CVOPCNODE | CreateCVOPCObjectFromTypeW (cvbuint16_t NameSpaceIndex, const wchar_t *Name, CVOPCNODEID Parent, CVOPCNODEID TypeDefinition) |
Creates an OPCUA Object with the specified parameter and the type definition. More... | |
CVOPCNODE | CreateCVOPCObjectType (cvbuint16_t NameSpaceIndex, const char *Name, CVOPCNODEID Parent, TCVOPCAbstractDataType IsAbstract) |
Creates an OPCUA ObjectType with the specified parameter. More... | |
CVOPCNODE | CreateCVOPCObjectTypeW (cvbuint16_t NameSpaceIndex, const wchar_t *Name, CVOPCNODEID Parent, TCVOPCAbstractDataType IsAbstract) |
Creates an OPCUA ObjectType with the specified parameter. More... | |
CVOPCNODE | CreateCVOPCObjectW (cvbuint16_t NameSpaceIndex, const wchar_t *Name, CVOPCNODEID Parent) |
Creates an OPCUA Object with the specified parameter. More... | |
CVOPCNODE | CreateCVOPCVariableFloat (cvbuint16_t NameSpaceIndex, const char *Name, CVOPCNODEID Parent, TCVOPCVarType VarType, TCVOPCDataType DataType, double Value) |
Creates an OPCUA Variable with the specified parameter, data type and set its value as double. More... | |
CVOPCNODE | CreateCVOPCVariableFloatW (cvbuint16_t NameSpaceIndex, const wchar_t *Name, CVOPCNODEID Parent, TCVOPCVarType VarType, TCVOPCDataType DataType, double Value) |
Creates an OPCUA Variable with the specified parameter, data type and sets its value as double. More... | |
CVOPCNODE | CreateCVOPCVariableFromType (cvbuint16_t NameSpaceIndex, const char *Name, CVOPCNODEID Parent, CVOPCNODEID TypeDefinition) |
Creates an OPCUA Variable with the specified parameter and type definition. More... | |
CVOPCNODE | CreateCVOPCVariableFromTypeW (cvbuint16_t NameSpaceIndex, const wchar_t *Name, CVOPCNODEID Parent, CVOPCNODEID TypeDefinition) |
Creates an OPCUA Variable with the specified parameter and type definition. More... | |
CVOPCNODE | CreateCVOPCVariableInteger (cvbuint16_t NameSpaceIndex, const char *Name, CVOPCNODEID Parent, TCVOPCVarType VarType, TCVOPCDataType DataType, cvbint64_t Value) |
Creates an OPCUA Variable with the specified parameter, data type and set its value as int64. More... | |
CVOPCNODE | CreateCVOPCVariableIntegerW (cvbuint16_t NameSpaceIndex, const wchar_t *Name, CVOPCNODEID Parent, TCVOPCVarType VarType, TCVOPCDataType DataType, cvbint64_t Value) |
Creates an OPCUA Variable with the specified parameter, data type and set its value as int64. More... | |
CVOPCNODE | CreateCVOPCVariableString (cvbuint16_t NameSpaceIndex, const char *Name, CVOPCNODEID Parent, TCVOPCVarType VarType, TCVOPCDataType DataType, const char *Value) |
Creates an OPCUA Variable with the specified parameter, data type and C string value. More... | |
CVOPCNODE | CreateCVOPCVariableStringW (cvbuint16_t NameSpaceIndex, const wchar_t *Name, CVOPCNODEID Parent, TCVOPCVarType VarType, TCVOPCDataType DataType, const wchar_t *Value) |
Creates an OPCUA Variable with the specified parameter, data type and value as wide C string. More... | |
CVOPCNODE | CreateCVOPCVariableType (cvbuint16_t NameSpaceIndex, const char *Name, CVOPCNODEID Parent, TCVOPCAbstractDataType IsAbstract) |
Creates an OPCUA VariableType with the specified parameter. More... | |
CVOPCNODE | CreateCVOPCVariableTypeW (cvbuint16_t NameSpaceIndex, const wchar_t *Name, CVOPCNODEID Parent, TCVOPCAbstractDataType IsAbstract) |
Creates an OPCUA VariableType with the specified parameter. More... | |
cvbres_t | CVOPCGetAttributeIdDataType (TCVOPCAttributeId AttributeId, TCVOPCDataType &dataType) |
Returns the dataType of a specific node attribute. More... | |
cvbres_t | CVOPCNodeAddMethodArgAsFloat (CVOPCNODE Method, const char *ArgumentName, TCVOPCArgumentType ArgumentType, TCVOPCDataType DataType, double Value) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as double. More... | |
cvbres_t | CVOPCNodeAddMethodArgAsFloatW (CVOPCNODE Method, const wchar_t *ArgumentName, TCVOPCArgumentType ArgumentType, TCVOPCDataType DataType, double DefaultValue) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as double. More... | |
cvbres_t | CVOPCNodeAddMethodArgAsInteger (CVOPCNODE Method, const char *ArgumentName, TCVOPCArgumentType ArgumentType, TCVOPCDataType DataType, cvbint64_t Value) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as int64. More... | |
cvbres_t | CVOPCNodeAddMethodArgAsIntegerW (CVOPCNODE Method, const wchar_t *ArgumentName, TCVOPCArgumentType ArgumentType, TCVOPCDataType DataType, cvbint64_t DefaultValue) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as int64. More... | |
cvbres_t | CVOPCNodeAddMethodArgAsString (CVOPCNODE Method, const char *ArgumentName, TCVOPCArgumentType ArgumentType, TCVOPCDataType DataType, const char *Value) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as C String. More... | |
cvbres_t | CVOPCNodeAddMethodArgAsStringW (CVOPCNODE Method, const wchar_t *ArgumentName, TCVOPCArgumentType ArgumentType, TCVOPCDataType DataType, const wchar_t *DefaultValue) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as wide C String. More... | |
cvbres_t | CVOPCNodeAddReference (CVOPCNODE Source, CVOPCNODEID Destination, TCVOPCReferenceType Reference, TCVOPCReferenceDirection IsForward) |
Adds a reference to the OPCUA Server. More... | |
cvbres_t | CVOPCNodeBrowse (CVOPCNODE StartingNode, TCVOPCBrowseFilter *browseFilter, CVOPCBROWSERESULT &BrowseList) |
Browse the children of a given OPCUA Node present in the OPCUA Server which is connected to a given OPCUA Client. More... | |
cvbres_t | CVOPCNodeCallMethod (CVOPCNODE Method) |
Calls an OPCUA Method of an OPCUA Server which is connected via an OPCUA Client. More... | |
cvbres_t | CVOPCNodeGetAttributeAsFloat (CVOPCNODE Node, TCVOPCAttributeId AttributeId, double &Attribute) |
Gets the selected Attribute of an OPCUA Node object as double value. More... | |
cvbres_t | CVOPCNodeGetAttributeAsInteger (CVOPCNODE Node, TCVOPCAttributeId AttributeId, cvbint64_t &Attribute) |
Gets the selected Attribute of an OPCUA Node object as int64 value. More... | |
cvbres_t | CVOPCNodeGetAttributeAsString (CVOPCNODE Node, TCVOPCAttributeId AttributeId, char *Attribute, size_t &AttributeSize) |
Gets the selected Attribute of an OPCUA Node object as C string. More... | |
cvbres_t | CVOPCNodeGetAttributeAsStringW (CVOPCNODE Node, TCVOPCAttributeId AttributeId, wchar_t *Attribute, size_t &AttributeSize) |
Gets the selected Attribute of an OPCUA Node object as wide C string. More... | |
cvbres_t | CVOPCNodeGetConnectionStatus (CVOPCNODE Node, TCVOPCConnectionStatus &ConnectionStatus) |
Gets the #TOpcConnectionStatus connections status of an OPCUA Node object. More... | |
cvbres_t | CVOPCNodeGetMethodArgAsFloat (CVOPCNODE Method, TCVOPCArgumentType ArgumentType, size_t position, double &Value) |
Gets the given OPCUA Method Argument value as double. More... | |
cvbres_t | CVOPCNodeGetMethodArgAsInteger (CVOPCNODE Method, TCVOPCArgumentType ArgumentType, size_t position, cvbint64_t &Value) |
Gets the given OPCUA Method Argument value as int64. More... | |
cvbres_t | CVOPCNodeGetMethodArgAsString (CVOPCNODE Method, TCVOPCArgumentType ArgumentType, size_t position, char *Value, size_t &ValueSize) |
Gets the given OPCUA Method Argument value as C string. More... | |
cvbres_t | CVOPCNodeGetMethodArgAsStringW (CVOPCNODE Method, TCVOPCArgumentType ArgumentType, size_t position, wchar_t *Value, size_t &ValueSize) |
Gets the given OPCUA Method Argument value as wide C string. More... | |
cvbres_t | CVOPCNodeGetMethodArgCount (CVOPCNODE Method, TCVOPCArgumentType ArgumentType, size_t &ArgumentCount) |
Gets the number of input or output Arguments in the given OPCUA Method. More... | |
cvbres_t | CVOPCNodeGetMethodArgDataType (CVOPCNODE Method, TCVOPCArgumentType ArgumentType, size_t position, TCVOPCDataType &DataClass) |
Queries the data class (integer, float or string) of the selected input or output argument of a given OPCUA Method. More... | |
cvbres_t | CVOPCNodeGetNodeClass (CVOPCNODE Node, TCVOPCNodeClass &NodeClass) |
Gets the OPCUA NodeClass of an OPCUA Node object. More... | |
cvbres_t | CVOPCNodeGetNodeId (CVOPCNODE Node, CVOPCNODEID &NodeId) |
Gets the OPCUA DataType of an OPCUA Node object. More... | |
cvbres_t | CVOPCNodeSetAttributeAsFloat (CVOPCNODE Node, TCVOPCAttributeId AttributeId, double Attribute) |
Sets the selected Attribute of an OPCUA Node object as a double. More... | |
cvbres_t | CVOPCNodeSetAttributeAsInteger (CVOPCNODE Node, TCVOPCAttributeId AttributeId, cvbint64_t Attribute) |
Sets the selected Attribute of an OPCUA Node object as an int64 . More... | |
cvbres_t | CVOPCNodeSetAttributeAsString (CVOPCNODE Node, TCVOPCAttributeId AttributeId, const char *Attribute) |
Sets the selected Attribute of an OPCUA Node object as a C string . More... | |
cvbres_t | CVOPCNodeSetAttributeAsStringW (CVOPCNODE Node, TCVOPCAttributeId AttributeId, const wchar_t *Attribute) |
Sets the selected Attribute of an OPCUA Node object as wide C string. More... | |
cvbres_t | CVOPCNodeSetMethodArgAsFloat (CVOPCNODE Method, TCVOPCArgumentType ArgumentType, size_t position, double Value) |
Sets the given OPCUA Method Argument value as double. More... | |
cvbres_t | CVOPCNodeSetMethodArgAsInteger (CVOPCNODE Method, TCVOPCArgumentType ArgumentType, size_t position, cvbint64_t Value) |
Sets the given OPCUA Method Argument value as int64. More... | |
cvbres_t | CVOPCNodeSetMethodArgAsString (CVOPCNODE Method, TCVOPCArgumentType ArgumentType, size_t position, const char *Value) |
Sets the given OPCUA Method Argument value as wide C string. More... | |
cvbres_t | CVOPCNodeSetMethodArgAsStringW (CVOPCNODE Method, TCVOPCArgumentType ArgumentType, size_t position, const wchar_t *Value) |
Sets the given OPCUA Method Argument value as wide C string. More... | |
cvbres_t | CVOPCNodeSetModelingRule (CVOPCNODE Node, TCVOPCModRule ModellingRule) |
Sets the OPCUA Modelling Rule of an OPCUA Node object. More... | |
cvbres_t | CVOPCNodeSetParentReference (CVOPCNODE Node, TCVOPCReferenceType Reference) |
Sets the parent's reference type of an OPCUA Node object. More... | |
cvbres_t | CVOpcNSetNodeId (CVOPCNODE Node, CVOPCNODEID NodeId) |
Sets the OPCUA NodeId of an OPCUA Node object. More... | |
cvbres_t | CVOpcNSetVDataClass (CVOPCNODE VariableOrType, TCVOPCDataType DataType) |
Sets the OPCUA DataType of an OPCUA Variable or VariableType object. More... | |
cvbbool_t | IsCVOPCNode (CVOPCNODE Node) |
Checks if handle is valid and points to OPCUA Node. More... | |
Functions to create and access OPCUA Node objects and its attributes. Available node classes are Variable, Object, Method, VariableType and ObjectType. Variables and Objects could be instantiated. Methods are always linked to one object. VariableTypes and ObjectTypes could be used a model for Variables and Object instances.
Handle of an OPCUA Node object.
The following node attributes cannot be changed once a node has been created:
The following attributes cannot be written from the server (but from the client), as they are specific to the different users:
Historizing is currently unsupported
CVOPCNODE objects are reference counted. If one is not needed anymore call the ReleaseObject function of the CVCImg.dll. It is recommended to call the ShareObject function in a program unit (like a class or function) when a handle is set and call ReleaseObject when the handle is not needed anymore.
CVOPCNODE CreateCVOPCMethod | ( | cvbuint16_t | NameSpaceIndex, |
const char * | Name, | ||
CVOPCNODEID | Parent | ||
) |
Creates an OPCUA Method Node with the specified parameter.
nullptr
. Use only initialized parameters to create OPCUA Method Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Method should belong to. |
[in] | Name | String literal for non-localized, human-readable name of an OPCUA Method. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Method to be created belongs to. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCMethodW | ( | cvbuint16_t | NameSpaceIndex, |
const wchar_t * | Name, | ||
CVOPCNODEID | Parent | ||
) |
Creates an OPCUA Method Node with the specified parameter.
nullptr
. Use only initialized parameters to create OPCUA Method Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Method should belong to. |
[in] | Name | Wide C String literal for non-localized, human-readable name of an OPCUA Method. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Method to be created belongs. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCObject | ( | cvbuint16_t | NameSpaceIndex, |
const char * | Name, | ||
CVOPCNODEID | Parent | ||
) |
Creates an OPCUA Object with the specified parameter.
nullptr
. Use only initialized parameters to create OPCUA Object Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Object should belong to. |
[in] | Name | String literal for non-localized, human-readable name of an OPCUA Object. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Object to be created belongs to. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCObjectFromType | ( | cvbuint16_t | NameSpaceIndex, |
const char * | Name, | ||
CVOPCNODEID | Parent, | ||
CVOPCNODEID | TypeDefinition | ||
) |
Creates an OPCUA Object with the specified parameter and the type definition.
nullptr
. Use only initialized parameters to create OPCUA Object Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Object should belong to. |
[in] | Name | String literal for non-localized, human-readable name of an OPCUA Object. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Object to be created belongs to. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCObjectFromTypeW | ( | cvbuint16_t | NameSpaceIndex, |
const wchar_t * | Name, | ||
CVOPCNODEID | Parent, | ||
CVOPCNODEID | TypeDefinition | ||
) |
Creates an OPCUA Object with the specified parameter and the type definition.
nullptr
. Use only initialized parameters to create OPCUA Object Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Object should belong to. |
[in] | Name | String literal for non-localized, human-readable name of an OPCUA Object. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Object to be created belongs to. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCObjectType | ( | cvbuint16_t | NameSpaceIndex, |
const char * | Name, | ||
CVOPCNODEID | Parent, | ||
TCVOPCAbstractDataType | IsAbstract | ||
) |
Creates an OPCUA ObjectType with the specified parameter.
nullptr
. Use only initialized parameters to create OPCUA ObjectType Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA ObjectType should belong to. |
[in] | Name | String literal for non-localized, human-readable name of an OPCUA VariableType. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA ObjectType to be created belongs. |
[in] | IsAbstract | Boolean which defines the OPCUA ObjectType to be abstract if TRUE |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCObjectTypeW | ( | cvbuint16_t | NameSpaceIndex, |
const wchar_t * | Name, | ||
CVOPCNODEID | Parent, | ||
TCVOPCAbstractDataType | IsAbstract | ||
) |
Creates an OPCUA ObjectType with the specified parameter.
nullptr
. Use only initialized parameters to create OPCUA ObjectType Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA ObjectType should belong to. |
[in] | Name | Wide C string literal for non-localized, human-readable name of an OPCUA VariableType. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA ObjectType to be created belongs. |
[in] | IsAbstract | Boolean which defines the OPCUA ObjectType to be abstract if TRUE |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCObjectW | ( | cvbuint16_t | NameSpaceIndex, |
const wchar_t * | Name, | ||
CVOPCNODEID | Parent | ||
) |
Creates an OPCUA Object with the specified parameter.
nullptr
. Use only initialized parameters to create OPCUA Object Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Object should belong to. |
[in] | Name | Wide C string literal for non-localized, human-readable name of an OPCUA Object. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Object to be created belongs to. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCVariableFloat | ( | cvbuint16_t | NameSpaceIndex, |
const char * | Name, | ||
CVOPCNODEID | Parent, | ||
TCVOPCVarType | VarType, | ||
TCVOPCDataType | DataType, | ||
double | Value | ||
) |
Creates an OPCUA Variable with the specified parameter, data type and set its value as double.
nullptr
. Use only initialized parameters to create OPCUA Variable Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Node should belong to. |
[in] | Name | String literal for non-localized, human-readable name of an OPCUA Node. This string must be 0 terminated. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Node to be created belongs. |
[in] | VarType | OPCUA Node Type for the OPCUA Node to created. |
[in] | DataType | Data type definition of the OPCUA Variable to be created. |
[in] | Value | Sets the value of the OPCUA Variable as double. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCVariableFloatW | ( | cvbuint16_t | NameSpaceIndex, |
const wchar_t * | Name, | ||
CVOPCNODEID | Parent, | ||
TCVOPCVarType | VarType, | ||
TCVOPCDataType | DataType, | ||
double | Value | ||
) |
Creates an OPCUA Variable with the specified parameter, data type and sets its value as double.
nullptr
. Use only initialized parameters to create OPCUA Variable Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Node should belong to. |
[in] | Name | Wide C string literal for non-localized, human-readable name of an OPCUA Node. This wide string must be 0 terminated. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Node to be created belongs. |
[in] | VarType | OPCUA Node Type for the OPCUA Node to created. |
[in] | DataType | Data type definition of the OPCUA Variable to be created. |
[in] | Value | Sets the value of the OPCUA Variable as double. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCVariableFromType | ( | cvbuint16_t | NameSpaceIndex, |
const char * | Name, | ||
CVOPCNODEID | Parent, | ||
CVOPCNODEID | TypeDefinition | ||
) |
Creates an OPCUA Variable with the specified parameter and type definition.
nullptr
. Use only initialized parameters to create OPCUA Variable Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Node should belong to. |
[in] | Name | String literal for non-localized, human-readable name of an OPCUA Node. This string must be 0 terminated. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Node to be created belongs. |
[in] | TypeDefinition | Type definition that is used to instantiate the OPCUA Node. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCVariableFromTypeW | ( | cvbuint16_t | NameSpaceIndex, |
const wchar_t * | Name, | ||
CVOPCNODEID | Parent, | ||
CVOPCNODEID | TypeDefinition | ||
) |
Creates an OPCUA Variable with the specified parameter and type definition.
nullptr
. Use only initialized parameters to create OPCUA Variable Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Node should belong to. |
[in] | Name | Wide C string literal for non-localized, human-readable name of an OPCUA Node. This wide string must be 0 terminated. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Node to be created belongs. |
[in] | TypeDefinition | Type definition that is used to instantiate the OPCUA Node. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCVariableInteger | ( | cvbuint16_t | NameSpaceIndex, |
const char * | Name, | ||
CVOPCNODEID | Parent, | ||
TCVOPCVarType | VarType, | ||
TCVOPCDataType | DataType, | ||
cvbint64_t | Value | ||
) |
Creates an OPCUA Variable with the specified parameter, data type and set its value as int64.
nullptr
. Use only initialized parameters to create OPCUA Variable Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Node should belong to. |
[in] | Name | String literal for non-localized, human-readable name of an OPCUA Node. This string must be 0 terminated. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Node to be created belongs. |
[in] | VarType | OPCUA Node Type for the OPCUA Node to created. |
[in] | DataType | Data type definition of the OPCUA Node to be created. |
[in] | Value | Sets the value of the OPCUA Variable as int64. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCVariableIntegerW | ( | cvbuint16_t | NameSpaceIndex, |
const wchar_t * | Name, | ||
CVOPCNODEID | Parent, | ||
TCVOPCVarType | VarType, | ||
TCVOPCDataType | DataType, | ||
cvbint64_t | Value | ||
) |
Creates an OPCUA Variable with the specified parameter, data type and set its value as int64.
nullptr
. Use only initialized parameters to create OPCUA Variable Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Node should belong to. |
[in] | Name | Wide C string literal for non-localized, human-readable name of an OPCUA Node. This wide string must be 0 terminated. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Node to be created belongs. |
[in] | VarType | OPCUA Node Type for the OPCUA Node to created. |
[in] | DataType | Data type definition of the OPCUA Node to be created. |
[in] | Value | Sets the value of the OPCUA Variable as int64. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCVariableString | ( | cvbuint16_t | NameSpaceIndex, |
const char * | Name, | ||
CVOPCNODEID | Parent, | ||
TCVOPCVarType | VarType, | ||
TCVOPCDataType | DataType, | ||
const char * | Value | ||
) |
Creates an OPCUA Variable with the specified parameter, data type and C string value.
nullptr
. Use only initialized parameters to create OPCUA Variable Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Node should belong to. |
[in] | Name | String literal for non-localized, human-readable name of an OPCUA Node. This string must be 0 terminated. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Node to be created belongs. |
[in] | VarType | OPCUA Node Type for the OPCUA Node to created. |
[in] | DataType | Data type definition of the OPCUA Node to be created. |
[in] | Value | Sets the value of the OPCUA Variable as C string. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCVariableStringW | ( | cvbuint16_t | NameSpaceIndex, |
const wchar_t * | Name, | ||
CVOPCNODEID | Parent, | ||
TCVOPCVarType | VarType, | ||
TCVOPCDataType | DataType, | ||
const wchar_t * | Value | ||
) |
Creates an OPCUA Variable with the specified parameter, data type and value as wide C string.
nullptr
. Use only initialized parameters to create OPCUA Variable Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA Node should belong to. |
[in] | Name | Wide C string literal for non-localized, human-readable name of an OPCUA Node. This wide string must be 0 terminated. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA Node to be created belongs. |
[in] | VarType | OPCUA Node Type for the OPCUA Node to created. |
[in] | DataType | Data type definition of the OPCUA Node to be created. |
[in] | Value | Sets the value of the OPCUA Variable as wide C string. |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCVariableType | ( | cvbuint16_t | NameSpaceIndex, |
const char * | Name, | ||
CVOPCNODEID | Parent, | ||
TCVOPCAbstractDataType | IsAbstract | ||
) |
Creates an OPCUA VariableType with the specified parameter.
nullptr
. Use only initialized parameters to create OPCUA VariableType Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA VariableType should belong to. |
[in] | Name | String literal for non-localized, human-readable name of an OPCUA VariableType. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA VariableType to be created belongs. |
[in] | IsAbstract | Boolean which defines the OPCUA VariableType to be abstract if TRUE |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). CVOPCNODE CreateCVOPCVariableTypeW | ( | cvbuint16_t | NameSpaceIndex, |
const wchar_t * | Name, | ||
CVOPCNODEID | Parent, | ||
TCVOPCAbstractDataType | IsAbstract | ||
) |
Creates an OPCUA VariableType with the specified parameter.
nullptr
. Use only initialized parameters to create OPCUA VariableType Nodes.[in] | NameSpaceIndex | Index of the namespace where the OPCUA VariableType should belong to. |
[in] | Name | Wide C string literal for non-localized, human-readable name of an OPCUA VariableType. |
[in] | Parent | OPCUA NodeId of the parent to which the OPCUA VariableType to be created belongs. |
[in] | IsAbstract | Boolean which defines the OPCUA VariableType to be abstract if TRUE |
nullptr
on error (Use CVOPCGetLastErrorString function for a human readable error description). cvbres_t CVOPCGetAttributeIdDataType | ( | TCVOPCAttributeId | AttributeId, |
TCVOPCDataType & | dataType | ||
) |
Returns the dataType of a specific node attribute.
[in] | AttributeId | Identifier for the attribute which data type is queried. |
[out] | TCVOpcDataType | Data type of the selected attribute. |
cvbres_t CVOPCNodeAddMethodArgAsFloat | ( | CVOPCNODE | Method, |
const char * | ArgumentName, | ||
TCVOPCArgumentType | ArgumentType, | ||
TCVOPCDataType | DataType, | ||
double | Value | ||
) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as double.
nullptr
.[in] | Method | OPCUA Method object where the Argument should be added. |
[in] | ArgumentName | String literal for human-readable name of the argument. This string must be 0 terminated. |
[in] | ArgumentType | Defines if argument is used as input or output. |
[in] | DataType | OPCUA DataType of the OPCUA Method Argument. |
[in] | Value | Sets default value of the Argument as double. |
cvbres_t CVOPCNodeAddMethodArgAsFloatW | ( | CVOPCNODE | Method, |
const wchar_t * | ArgumentName, | ||
TCVOPCArgumentType | ArgumentType, | ||
TCVOPCDataType | DataType, | ||
double | DefaultValue | ||
) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as double.
nullptr
.[in] | Method | OPCUA Method object where the Argument should be added. |
[in] | ArgumentName | Wide string literal for human-readable name of the argument. This wide string must be 0 terminated. |
[in] | ArgumentType | Defines if argument is used as input or output. |
[in] | DataType | OPCUA DataType of the OPCUA Method Argument. |
[in] | Value | Sets default value of the Argument as double. |
cvbres_t CVOPCNodeAddMethodArgAsInteger | ( | CVOPCNODE | Method, |
const char * | ArgumentName, | ||
TCVOPCArgumentType | ArgumentType, | ||
TCVOPCDataType | DataType, | ||
cvbint64_t | Value | ||
) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as int64.
nullptr
.[in] | Method | OPCUA Method object where the Argument should be added. |
[in] | ArgumentName | String literal for human-readable name of the argument. This string must be 0 terminated. |
[in] | ArgumentType | Defines if argument is used as input or output. |
[in] | DataType | OPCUA DataType of the OPCUA Method Argument. |
[in] | Value | Sets default value of the Argument as int64. |
cvbres_t CVOPCNodeAddMethodArgAsIntegerW | ( | CVOPCNODE | Method, |
const wchar_t * | ArgumentName, | ||
TCVOPCArgumentType | ArgumentType, | ||
TCVOPCDataType | DataType, | ||
cvbint64_t | DefaultValue | ||
) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as int64.
nullptr
.[in] | Method | OPCUA Method object where the Argument should be added. |
[in] | ArgumentName | Wide string literal for human-readable name of the argument. This wide string must be 0 terminated. |
[in] | ArgumentType | Defines if argument is used as input or output. |
[in] | DataType | OPCUA DataType of the OPCUA Method Argument. |
[in] | Value | Sets default value of the Argument as int64. |
cvbres_t CVOPCNodeAddMethodArgAsString | ( | CVOPCNODE | Method, |
const char * | ArgumentName, | ||
TCVOPCArgumentType | ArgumentType, | ||
TCVOPCDataType | DataType, | ||
const char * | Value | ||
) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as C String.
nullptr
.[in] | Method | OPCUA Method object where the Argument should be added. |
[in] | ArgumentName | String literal for human-readable name of the argument. This string must be 0 terminated. |
[in] | ArgumentType | Defines if argument is used as input or output. |
[in] | DataType | OPCUA DataType of the OPCUA Method Argument. |
[in] | Value | String Sets default value of the Argument as C String. |
cvbres_t CVOPCNodeAddMethodArgAsStringW | ( | CVOPCNODE | Method, |
const wchar_t * | ArgumentName, | ||
TCVOPCArgumentType | ArgumentType, | ||
TCVOPCDataType | DataType, | ||
const wchar_t * | DefaultValue | ||
) |
Adds Argument with defined DataType to OPCUA Method. Initial value is set as wide C String.
nullptr
.[in] | Method | OPCUA Method object where the Argument should be added. |
[in] | ArgumentName | Wide String literal for human-readable name of the argument. This wide string must be 0 terminated. |
[in] | ArgumentType | Defines if argument is used as input or output. |
[in] | DataType | OPCUA DataType of the OPCUA Method Argument. |
[in] | Value | String Sets default value of the Argument as wide C String. |
cvbres_t CVOPCNodeAddReference | ( | CVOPCNODE | Source, |
CVOPCNODEID | Destination, | ||
TCVOPCReferenceType | Reference, | ||
TCVOPCReferenceDirection | IsForward | ||
) |
Adds a reference to the OPCUA Server.
nullptr
.[in] | Source | OPCUA Node that is the source of the reference. |
[in] | Destination | OPCUA Node that is the destination of the reference. |
[in] | Reference | OPCUA Reference of a certain ReferenceType that defines the relationship between two nodes. |
[in] | IsForward | Boolean flag that defines if the reference is forward reference or backward reference. |
cvbres_t CVOPCNodeBrowse | ( | CVOPCNODE | StartingNode, |
TCVOPCBrowseFilter * | browseFilter, | ||
CVOPCBROWSERESULT & | BrowseList | ||
) |
Browse the children of a given OPCUA Node present in the OPCUA Server which is connected to a given OPCUA Client.
[in] | Client | OPCUA Client handle. |
[in] | StartingNode | OPCUA NodeId of the OPCUA Node where the browse operation should start. |
[in] | Depth | Depth of the browse operation on the address space node set is limited to this parameter. |
[in] | MaxResults | Maximum number of nodes that will be returned from the browse operation. |
[out] | BrowseList | Reference to BrowseList object that contains the result of the browse operation. |
cvbres_t CVOPCNodeCallMethod | ( | CVOPCNODE | Method | ) |
Calls an OPCUA Method of an OPCUA Server which is connected via an OPCUA Client.
[in] | Client | OPCUA Client handle. |
[in] | MethodNodeId | OPCUA NodeId that uniquely identifies the OPCUA Method. |
cvbres_t CVOPCNodeGetAttributeAsFloat | ( | CVOPCNODE | Node, |
TCVOPCAttributeId | AttributeId, | ||
double & | Attribute | ||
) |
Gets the selected Attribute of an OPCUA Node object as double value.
nullptr
.[in] | Node | OPCUA Node which should be read. |
[in] | AttributeId | OPCUA AttributeId for the given OPCUA Node. |
[out] | Attribute | Reference to variable in which the current Attribute of the OPCUA Node is written. |
cvbres_t CVOPCNodeGetAttributeAsInteger | ( | CVOPCNODE | Node, |
TCVOPCAttributeId | AttributeId, | ||
cvbint64_t & | Attribute | ||
) |
Gets the selected Attribute of an OPCUA Node object as int64 value.
nullptr
.[in] | Node | OPCUA Node which should be read. |
[in] | AttributeId | OPCUA AttributeId for the given OPCUA Node. |
[out] | Attribute | Reference to variable in which the current Attribute of the OPCUA Node is written. |
cvbres_t CVOPCNodeGetAttributeAsString | ( | CVOPCNODE | Node, |
TCVOPCAttributeId | AttributeId, | ||
char * | Attribute, | ||
size_t & | AttributeSize | ||
) |
Gets the selected Attribute of an OPCUA Node object as C string.
nullptr
.[in] | Node | OPCUA Node which should be read. |
[in] | AttributeId | OPCUA AttributeId for the given OPCUA Node. |
[in] | Attribute | char buffer to be filled with queried information; nullptr for size query. |
[in,out] | ] | AttributeSize Gives the buffer size of Attribute or receives the minimal needed size (including the terminating zero in either case) if Attribute is NULL . |
cvbres_t CVOPCNodeGetAttributeAsStringW | ( | CVOPCNODE | Node, |
TCVOPCAttributeId | AttributeId, | ||
wchar_t * | Attribute, | ||
size_t & | AttributeSize | ||
) |
Gets the selected Attribute of an OPCUA Node object as wide C string.
nullptr
.[in] | Node | OPCUA Node which should be read. |
[in] | AttributeId | OPCUA AttributeId for the given OPCUA Node. |
[in] | Attribute | Wide char buffer to be filled with queried information; nullptr for size query. |
[in,out] | ] | AttributeSize Gives the buffer size of Attribute or receives the minimal needed size (including the terminating zero in either case) if Attribute is NULL . |
cvbres_t CVOPCNodeGetConnectionStatus | ( | CVOPCNODE | Node, |
TCVOPCConnectionStatus & | ConnectionStatus | ||
) |
Gets the #TOpcConnectionStatus connections status of an OPCUA Node object.
nullptr
.[in] | Node | OPCUA Node which should be read. |
[out] | NodeClass | OPCUA NodeId of the given OPCUA Node. |
cvbres_t CVOPCNodeGetMethodArgAsFloat | ( | CVOPCNODE | Method, |
TCVOPCArgumentType | ArgumentType, | ||
size_t | position, | ||
double & | Value | ||
) |
Gets the given OPCUA Method Argument value as double.
nullptr
.[in] | Method | OPCUA Method object. |
[out] | Value | Reference to variable in which the current value of the selected OPCUA Method Argument is written. |
[in] | ArgumentType | Defines which argument type (input or output arguments) should be inspected. |
[in] | DataClass | data class (integer, float or string) |
[in] | Position | Index used to identify the input or output argument which data class should be queried |
cvbres_t CVOPCNodeGetMethodArgAsInteger | ( | CVOPCNODE | Method, |
TCVOPCArgumentType | ArgumentType, | ||
size_t | position, | ||
cvbint64_t & | Value | ||
) |
Gets the given OPCUA Method Argument value as int64.
nullptr
.[in] | Method | OPCUA Method object. |
[out] | Value | Reference to variable in which the current value of the selected OPCUA Method Argument is written. |
[in] | ArgumentType | Defines which argument type (input or output arguments) should be inspected. |
[in] | DataClass | data class (integer, float or string) |
[in] | Position | Index used to identify the input or output argument which data class should be queried |
cvbres_t CVOPCNodeGetMethodArgAsString | ( | CVOPCNODE | Method, |
TCVOPCArgumentType | ArgumentType, | ||
size_t | position, | ||
char * | Value, | ||
size_t & | ValueSize | ||
) |
Gets the given OPCUA Method Argument value as C string.
nullptr
.[in] | Method | OPCUA Method object. |
[out] | Value | char buffer to be filled with queried information; nullptr for size query. |
[in,out] | ] | ValueSize Gives the buffer size of Value of the selected OPCUA Method Argument or receives the minimal needed size (including the terminating zero in either case) if Value is NULL . |
[in] | ArgumentType | Defines which argument type (input or output arguments) should be inspected. |
[in] | Position | Index used to identify the input or output argument which data class should be queried |
cvbres_t CVOPCNodeGetMethodArgAsStringW | ( | CVOPCNODE | Method, |
TCVOPCArgumentType | ArgumentType, | ||
size_t | position, | ||
wchar_t * | Value, | ||
size_t & | ValueSize | ||
) |
Gets the given OPCUA Method Argument value as wide C string.
nullptr
.[in] | Method | OPCUA Method object. |
[out] | Value | Wide char buffer to be filled with queried information; nullptr for size query. |
[in,out] | ] | ValueSize Gives the buffer size of Value of the selected OPCUA Method Argument or receives the minimal needed size (including the terminating zero in either case) if Value is NULL . |
[in] | ArgumentType | Defines which argument type (input or output arguments) should be inspected. |
[in] | Position | Index used to identify the input or output argument which data class should be queried |
cvbres_t CVOPCNodeGetMethodArgCount | ( | CVOPCNODE | Method, |
TCVOPCArgumentType | ArgumentType, | ||
size_t & | ArgumentCount | ||
) |
Gets the number of input or output Arguments in the given OPCUA Method.
nullptr
.[in] | Method | OPCUA Method object. |
[in] | ArgumentType | Defines which argument type (input or output arguments) should be counted. |
[out] | ArgumentCount | Number of input or output arguments depending on the ArgumentType |
cvbres_t CVOPCNodeGetMethodArgDataType | ( | CVOPCNODE | Method, |
TCVOPCArgumentType | ArgumentType, | ||
size_t | position, | ||
TCVOPCDataType & | DataClass | ||
) |
Queries the data class (integer, float or string) of the selected input or output argument of a given OPCUA Method.
nullptr
.[in] | Method | OPCUA Method object. |
[in] | ArgumentType | Defines which argument type (input or output arguments) should be inspected. |
[out] | DataClass | data class (integer, float or string) |
[in] | Position | Index used to identify the input or output argument which data class should be queried |
cvbres_t CVOPCNodeGetNodeClass | ( | CVOPCNODE | Node, |
TCVOPCNodeClass & | NodeClass | ||
) |
Gets the OPCUA NodeClass of an OPCUA Node object.
nullptr
.[in] | Node | OPCUA Node which NodeClass should be queried. |
[out] | NodeClass | OPCUA NodeId of the given OPCUA Node. |
cvbres_t CVOPCNodeGetNodeId | ( | CVOPCNODE | Node, |
CVOPCNODEID & | NodeId | ||
) |
Gets the OPCUA DataType of an OPCUA Node object.
nullptr
.[in] | Node | OPCUA Node which NodeId should be accessed. |
[out] | NodeId | OPCUA NodeId of the given OPCUA Node. |
cvbres_t CVOPCNodeSetAttributeAsFloat | ( | CVOPCNODE | Node, |
TCVOPCAttributeId | AttributeId, | ||
double | Attribute | ||
) |
Sets the selected Attribute of an OPCUA Node object as a double.
nullptr
.[in] | Node | OPCUA Node which should be modified. |
[in] | AttributeId | OPCUA AttributeId for the given OPCUA Node. |
[in] | Attribute | New value of the OPCUA Node Attribute. |
cvbres_t CVOPCNodeSetAttributeAsInteger | ( | CVOPCNODE | Node, |
TCVOPCAttributeId | AttributeId, | ||
cvbint64_t | Attribute | ||
) |
Sets the selected Attribute of an OPCUA Node object as an int64 .
nullptr
.[in] | Node | OPCUA Node which should be modified. |
[in] | AttributeId | OPCUA AttributeId for the given OPCUA Node. |
[in] | Attribute | New value of the OPCUA Node Attribute. |
cvbres_t CVOPCNodeSetAttributeAsString | ( | CVOPCNODE | Node, |
TCVOPCAttributeId | AttributeId, | ||
const char * | Attribute | ||
) |
Sets the selected Attribute of an OPCUA Node object as a C string .
nullptr
.[in] | Node | OPCUA Node which should be modified. |
[in] | AttributeId | OPCUA AttributeId for the given OPCUA Node. |
[in] | Attribute | New value of the OPCUA Node Attribute. This string must be 0 terminated. |
cvbres_t CVOPCNodeSetAttributeAsStringW | ( | CVOPCNODE | Node, |
TCVOPCAttributeId | AttributeId, | ||
const wchar_t * | Attribute | ||
) |
Sets the selected Attribute of an OPCUA Node object as wide C string.
nullptr
. Not every attribute could be set as a string.[in] | Node | OPCUA Node which should be modified. |
[in] | AttributeId | OPCUA AttributeId for the given OPCUA Node. |
[in] | Attribute | New value of the OPCUA Node Attribute. The wide C string must be 0 terminated. |
cvbres_t CVOPCNodeSetMethodArgAsFloat | ( | CVOPCNODE | Method, |
TCVOPCArgumentType | ArgumentType, | ||
size_t | position, | ||
double | Value | ||
) |
Sets the given OPCUA Method Argument value as double.
nullptr
.[in] | Method | OPCUA Method object. |
[in] | Value | New value of the selected argument represented as double. |
[in] | ArgumentType | Defines which argument type (input or output arguments) should be inspected. |
[in] | DataClass | data class (integer, float or string) |
[in] | Position | Index used to identify the input or output argument which data class should be queried |
cvbres_t CVOPCNodeSetMethodArgAsInteger | ( | CVOPCNODE | Method, |
TCVOPCArgumentType | ArgumentType, | ||
size_t | position, | ||
cvbint64_t | Value | ||
) |
Sets the given OPCUA Method Argument value as int64.
nullptr
.[in] | Method | OPCUA Method object. |
[in] | Value | New value of the selected argument represented as int64. |
[in] | ArgumentType | Defines which argument type (input or output arguments) should be inspected. |
[in] | DataClass | data class (integer, float or string) |
[in] | Position | Index used to identify the input or output argument which data class should be queried |
cvbres_t CVOPCNodeSetMethodArgAsString | ( | CVOPCNODE | Method, |
TCVOPCArgumentType | ArgumentType, | ||
size_t | position, | ||
const char * | Value | ||
) |
Sets the given OPCUA Method Argument value as wide C string.
nullptr
.[in] | Method | OPCUA Method object. |
[in] | Value | New value of the selected argument represented as C string. This string must be 0 terminated. |
[in] | ArgumentType | Defines which argument type (input or output arguments) should be inspected. |
[in] | Position | Index used to identify the input or output argument which data class should be queried |
cvbres_t CVOPCNodeSetMethodArgAsStringW | ( | CVOPCNODE | Method, |
TCVOPCArgumentType | ArgumentType, | ||
size_t | position, | ||
const wchar_t * | Value | ||
) |
Sets the given OPCUA Method Argument value as wide C string.
nullptr
.[in] | Method | OPCUA Method object. |
[in] | Value | New value of the selected argument represented as wide C string. This wide string must be 0 terminated. |
[in] | ArgumentType | Defines which argument type (input or output arguments) should be inspected. |
[in] | Position | Index used to identify the input or output argument which data class should be queried |
cvbres_t CVOPCNodeSetModelingRule | ( | CVOPCNODE | Node, |
TCVOPCModRule | ModellingRule | ||
) |
Sets the OPCUA Modelling Rule of an OPCUA Node object.
nullptr
.[in] | Node | OPCUA Node to be modified. |
[in] | ModellingRule | OPCUA ModellingRule for the given OPCUA Node object. |
cvbres_t CVOPCNodeSetParentReference | ( | CVOPCNODE | Node, |
TCVOPCReferenceType | Reference | ||
) |
Sets the parent's reference type of an OPCUA Node object.
nullptr
.[in] | Node | OPCUA Node to be modified. |
[out] | Parent | OPCUA NodeId of the parent for the given OPCUA Node object. |
[out] | RefenceType | OPCUA ReferenceType of for the given OPCUA Node object. |
cvbres_t CVOpcNSetNodeId | ( | CVOPCNODE | Node, |
CVOPCNODEID | NodeId | ||
) |
Sets the OPCUA NodeId of an OPCUA Node object.
nullptr
.[in] | Node | OPCUA Node which NodeId should be modified. |
[in] | NodeId | OPCUA NodeId to be set for the given OPCUA Node. |
cvbres_t CVOpcNSetVDataClass | ( | CVOPCNODE | VariableOrType, |
TCVOPCDataType | DataType | ||
) |
Sets the OPCUA DataType of an OPCUA Variable or VariableType object.
nullptr
.[in] | VariableOrType | OPCUA Variable or VariableType to be modified. |
[in] | DataType | OPCUA DataType for the given OPCUA Variable or VariableType object. |
cvbbool_t IsCVOPCNode | ( | CVOPCNODE | Node | ) |
Checks if handle is valid and points to OPCUA Node.
nullptr
.[in] | Node | OPCUA Node handle to check. |