IoT::OPC

class OPCClientRemoteObject

File Information

Library: IoT/OPC
Package: Generated
Header: IoT/OPC/OPCClientRemoteObject.h

Description

The interface for OPC clients.

This class provides a high-level, type-safe API for reading and writing attributes of the objects provided by an OPC server.

Inheritance

Direct Base Classes: IOPCClient, Poco::RemotingNG::RemoteObject

All Base Classes: IOPCClient, Poco::OSP::Service, Poco::RefCountedObject, Poco::RemotingNG::Identifiable, Poco::RemotingNG::RemoteObject

Member Summary

Member Functions: connect, connected, disconnect, enumerateChildren, expandNodeId, readAccessLevel, readArrayDimensions, readBooleanArray, readBooleanValue, readBrowseName, readByteArray, readByteStringArray, readByteStringValue, readByteValue, readDataType, readDateTimeArray, readDateTimeValue, readDescription, readDisplayName, readDoubleArray, readDoubleValue, readEventNotifier, readExecutable, readFloatArray, readFloatValue, readGUIDArray, readGUIDValue, readHistorizing, readInt16Array, readInt16Value, readInt32Array, readInt32Value, readInt64Array, readInt64Value, readInverseName, readIsAbstract, readMinimumSamplingInterval, readNoLoops, readNodeClass, readNodeId, readSByteArray, readSByteValue, readStringArray, readStringValue, readSymmetric, readUInt16Array, readUInt16Value, readUInt32Array, readUInt32Value, readUInt64Array, readUInt64Value, readUserAccessLevel, readUserExecutable, readUserWriteMask, readValueRank, readValueType, readWriteMask, remoting__typeId, resolveNodeId, resolvePath, serverURI, state, writeAccessLevel, writeArrayDimensions, writeBooleanArray, writeBooleanValue, writeBrowseName, writeByteArray, writeByteStringArray, writeByteStringValue, writeByteValue, writeDataType, writeDateTimeArray, writeDateTimeValue, writeDescription, writeDisplayName, writeDoubleArray, writeDoubleValue, writeEventNotifier, writeExecutable, writeFloatArray, writeFloatValue, writeGUIDArray, writeGUIDValue, writeHistorizing, writeInt16Array, writeInt16Value, writeInt32Array, writeInt32Value, writeInt64Array, writeInt64Value, writeInverseName, writeIsAbstract, writeMinimumSamplingInterval, writeNoLoops, writeNodeClass, writeNodeId, writeSByteArray, writeSByteValue, writeStringArray, writeStringValue, writeSymmetric, writeUInt16Array, writeUInt16Value, writeUInt32Array, writeUInt32Value, writeUInt64Array, writeUInt64Value, writeUserAccessLevel, writeUserExecutable, writeUserWriteMask, writeValueRank, writeWriteMask

Inherited Functions: connect, connected, disconnect, duplicate, enumerateChildren, expandNodeId, isA, mutex, readAccessLevel, readArrayDimensions, readBooleanArray, readBooleanValue, readBrowseName, readByteArray, readByteStringArray, readByteStringValue, readByteValue, readDataType, readDateTimeArray, readDateTimeValue, readDescription, readDisplayName, readDoubleArray, readDoubleValue, readEventNotifier, readExecutable, readFloatArray, readFloatValue, readGUIDArray, readGUIDValue, readHistorizing, readInt16Array, readInt16Value, readInt32Array, readInt32Value, readInt64Array, readInt64Value, readInverseName, readIsAbstract, readMinimumSamplingInterval, readNoLoops, readNodeClass, readNodeId, readSByteArray, readSByteValue, readStringArray, readStringValue, readSymmetric, readUInt16Array, readUInt16Value, readUInt32Array, readUInt32Value, readUInt64Array, readUInt64Value, readUserAccessLevel, readUserExecutable, readUserWriteMask, readValueRank, readValueType, readWriteMask, referenceCount, release, remoting__enableRemoteEvents, remoting__getURI, remoting__hasEvents, remoting__objectId, remoting__setURI, remoting__typeId, resolveNodeId, resolvePath, serverURI, state, type, writeAccessLevel, writeArrayDimensions, writeBooleanArray, writeBooleanValue, writeBrowseName, writeByteArray, writeByteStringArray, writeByteStringValue, writeByteValue, writeDataType, writeDateTimeArray, writeDateTimeValue, writeDescription, writeDisplayName, writeDoubleArray, writeDoubleValue, writeEventNotifier, writeExecutable, writeFloatArray, writeFloatValue, writeGUIDArray, writeGUIDValue, writeHistorizing, writeInt16Array, writeInt16Value, writeInt32Array, writeInt32Value, writeInt64Array, writeInt64Value, writeInverseName, writeIsAbstract, writeMinimumSamplingInterval, writeNoLoops, writeNodeClass, writeNodeId, writeSByteArray, writeSByteValue, writeStringArray, writeStringValue, writeSymmetric, writeUInt16Array, writeUInt16Value, writeUInt32Array, writeUInt32Value, writeUInt64Array, writeUInt64Value, writeUserAccessLevel, writeUserExecutable, writeUserWriteMask, writeValueRank, writeWriteMask

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < OPCClientRemoteObject >;

Constructors

OPCClientRemoteObject

OPCClientRemoteObject(
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    Poco::SharedPtr < IoT::OPC::OPCClient > pServiceObject
);

Creates a OPCClientRemoteObject.

Destructor

~OPCClientRemoteObject virtual

virtual ~OPCClientRemoteObject();

Destroys the OPCClientRemoteObject.

Member Functions

connect virtual inline

virtual void connect();

Connects to the server.

See also: IoT::OPC::IOPCClient::connect()

connected virtual inline

virtual bool connected() const;

Returns true if the client is connected to the server, otherwise false.

See also: IoT::OPC::IOPCClient::connected()

disconnect virtual inline

virtual void disconnect();

Disconnects from the server.

See also: IoT::OPC::IOPCClient::disconnect()

enumerateChildren virtual inline

std::vector < IoT::OPC::NodeInfo > enumerateChildren(
    const std::string & parentNodeId
);

Returns a vector containing information about all children of the node identified by parentNodeId.

Throws an OPCException if the children could not be enumerated.

See also: IoT::OPC::IOPCClient::enumerateChildren()

expandNodeId virtual inline

std::string expandNodeId(
    const std::string & nodeId
);

If the nodeId contains a namespace index, returns a new NodeIdString containing the corresponding namespace URI.

If no corresponding namespace URI is found, returns the same nodeId.

See also: IoT::OPC::IOPCClient::expandNodeId()

readAccessLevel virtual inline

virtual Poco::UInt8 readAccessLevel(
    const std::string & nodeId
);

Reads and returns the Access Level attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readAccessLevel()

readArrayDimensions virtual inline

std::vector < Poco::UInt32 > readArrayDimensions(
    const std::string & nodeId
);

Reads and returns the Array Dimensions attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readArrayDimensions()

readBooleanArray virtual inline

std::vector < bool > readBooleanArray(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of Boolean.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readBooleanArray()

readBooleanValue virtual inline

virtual bool readBooleanValue(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Boolean.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readBooleanValue()

readBrowseName virtual inline

IoT::OPC::QualifiedName readBrowseName(
    const std::string & nodeId
);

Reads and returns the Browse Name attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readBrowseName()

readByteArray virtual inline

std::vector < Poco::UInt8 > readByteArray(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of Byte.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readByteArray()

readByteStringArray virtual inline

std::vector < std::vector < char >> readByteStringArray(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of ByteString.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readByteStringArray()

readByteStringValue virtual inline

std::vector < char > readByteStringValue(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be ByteString.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type.

See also: IoT::OPC::IOPCClient::readByteStringValue()

readByteValue virtual inline

virtual Poco::UInt8 readByteValue(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Byte.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readByteValue()

readDataType virtual inline

std::string readDataType(
    const std::string & nodeId
);

Reads and returns the Data Type attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readDataType()

readDateTimeArray virtual inline

std::vector < Poco::DateTime > readDateTimeArray(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of DateTime. The OPC DateTime values are converted into Poco::DateTime values, which may lose some precision.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readDateTimeArray()

readDateTimeValue virtual inline

virtual Poco::DateTime readDateTimeValue(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be DateTime. The OPC DateTime is converted into a Poco::DateTime value, which may lose some precision.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readDateTimeValue()

readDescription virtual inline

IoT::OPC::LocalizedText readDescription(
    const std::string & nodeId
);

Reads and returns the Description attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readDescription()

readDisplayName virtual inline

IoT::OPC::LocalizedText readDisplayName(
    const std::string & nodeId
);

Reads and returns the Display Name attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readDisplayName()

readDoubleArray virtual inline

std::vector < double > readDoubleArray(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of Double.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readDoubleArray()

readDoubleValue virtual inline

virtual double readDoubleValue(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Double.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readDoubleValue()

readEventNotifier virtual inline

virtual Poco::UInt8 readEventNotifier(
    const std::string & nodeId
);

Reads and returns the Event Notifier attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readEventNotifier()

readExecutable virtual inline

virtual bool readExecutable(
    const std::string & nodeId
);

Reads and returns the Executable attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readExecutable()

readFloatArray virtual inline

std::vector < float > readFloatArray(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of Float.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readFloatArray()

readFloatValue virtual inline

virtual float readFloatValue(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Float.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readFloatValue()

readGUIDArray virtual inline

std::vector < Poco::UUID > readGUIDArray(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of GUID (UUID).

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readGUIDArray()

readGUIDValue virtual inline

virtual Poco::UUID readGUIDValue(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be GUID (UUID).

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readGUIDValue()

readHistorizing virtual inline

virtual bool readHistorizing(
    const std::string & nodeId
);

Reads and returns the Historizing attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readHistorizing()

readInt16Array virtual inline

std::vector < Poco::Int16 > readInt16Array(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of Int16.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readInt16Array()

readInt16Value virtual inline

virtual Poco::Int16 readInt16Value(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Int16.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readInt16Value()

readInt32Array virtual inline

std::vector < Poco::Int32 > readInt32Array(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of Int32.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readInt32Array()

readInt32Value virtual inline

virtual Poco::Int32 readInt32Value(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Int32.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readInt32Value()

readInt64Array virtual inline

std::vector < Poco::Int64 > readInt64Array(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of Int64.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readInt64Array()

readInt64Value virtual inline

virtual Poco::Int64 readInt64Value(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Int64.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readInt64Value()

readInverseName virtual inline

IoT::OPC::LocalizedText readInverseName(
    const std::string & nodeId
);

Reads and returns the Inverse Name attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readInverseName()

readIsAbstract virtual inline

virtual bool readIsAbstract(
    const std::string & nodeId
);

Reads and returns the Is Abstract attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readIsAbstract()

readMinimumSamplingInterval virtual inline

virtual double readMinimumSamplingInterval(
    const std::string & nodeId
);

Reads and returns the Minimum Sampling Interval attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readMinimumSamplingInterval()

readNoLoops virtual inline

virtual bool readNoLoops(
    const std::string & nodeId
);

Reads and returns the No Loops attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readNoLoops()

readNodeClass virtual inline

IoT::OPC::NodeClass readNodeClass(
    const std::string & nodeId
);

Reads and returns the Node Class attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readNodeClass()

readNodeId virtual inline

std::string readNodeId(
    const std::string & nodeId
);

Reads the Node ID attribute of the node identified by nodeId and converts it to stringified NodeIdString representation.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readNodeId()

readSByteArray virtual inline

std::vector < Poco::Int8 > readSByteArray(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of SByte.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readSByteArray()

readSByteValue virtual inline

virtual Poco::Int8 readSByteValue(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be SByte.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readSByteValue()

readStringArray virtual inline

std::vector < std::string > readStringArray(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of String.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readStringArray()

readStringValue virtual inline

virtual std::string readStringValue(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be String.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readStringValue()

readSymmetric virtual inline

virtual bool readSymmetric(
    const std::string & nodeId
);

Reads and returns the Symmetric attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readSymmetric()

readUInt16Array virtual inline

std::vector < Poco::UInt16 > readUInt16Array(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of UInt16.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readUInt16Array()

readUInt16Value virtual inline

virtual Poco::UInt16 readUInt16Value(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be UInt16.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readUInt16Value()

readUInt32Array virtual inline

std::vector < Poco::UInt32 > readUInt32Array(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of UInt32.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readUInt32Array()

readUInt32Value virtual inline

virtual Poco::UInt32 readUInt32Value(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be UInt32.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readUInt32Value()

readUInt64Array virtual inline

std::vector < Poco::UInt64 > readUInt64Array(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of UInt64.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readUInt64Array()

readUInt64Value virtual inline

virtual Poco::UInt64 readUInt64Value(
    const std::string & nodeId
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be UInt64.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type. Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readUInt64Value()

readUserAccessLevel virtual inline

virtual Poco::UInt8 readUserAccessLevel(
    const std::string & nodeId
);

Reads and returns the User Access Level attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readUserAccessLevel()

readUserExecutable virtual inline

virtual bool readUserExecutable(
    const std::string & nodeId
);

Reads and returns the User Executable attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readUserExecutable()

readUserWriteMask virtual inline

virtual Poco::UInt32 readUserWriteMask(
    const std::string & nodeId
);

Reads and returns the User Write Mask attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readUserWriteMask()

readValueRank virtual inline

virtual Poco::Int32 readValueRank(
    const std::string & nodeId
);

Reads and returns the Value Rank attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readValueRank()

readValueType virtual inline

virtual std::string readValueType(
    const std::string & nodeId
);

Reads the value of the node identified by nodeId and returns the value's type as a string (e.g., "Int32" or "Int32Array").

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readValueType()

readWriteMask virtual inline

virtual Poco::UInt32 readWriteMask(
    const std::string & nodeId
);

Reads and returns the Write Mask attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be read.

See also: IoT::OPC::IOPCClient::readWriteMask()

remoting__typeId virtual inline

virtual const Poco::RemotingNG::Identifiable::TypeId & remoting__typeId() const;

resolveNodeId virtual inline

std::string resolveNodeId(
    const std::string & nodeId
);

If the nodeId contains a namespace URI, returns a new NodeIdString containing the corresponding namespace index.

Throws an UnknownNamespaceException if the namespace URI cannot be resolved.

See also: IoT::OPC::IOPCClient::resolveNodeId()

resolvePath virtual inline

std::string resolvePath(
    const std::string & path,
    const std::string & rootId = std::string ()
);

Resolves a path consisting of slash-separated browse names to the NodeId of the resulting node, starting from the given root NodeIdString. The rootId can be empty. In this case, the path must start with a slash, which references the root node.

Example: Resolving the path "/" with a null root returns the NodeIdString of the Root Folder (ns=0;i=84). Resolving the path "/Objects/Server" returns the NodeIdString of the Server object (ns=0;i=2253).

If the path cannot be resolved, throws a PathNotFoundException.

Note that resolving a path is an expensive operation, requiring multiple calls to the OPC-UA server. Paths should be resolved only once per session, and the returned NodeId should be used for subsequent operations.

See also: IoT::OPC::IOPCClient::resolvePath()

serverURI virtual inline

virtual std::string serverURI() const;

Returns the URI of the server this client is connected to.

See also: IoT::OPC::IOPCClient::serverURI()

state virtual inline

IoT::OPC::ClientState state() const;

Returns the state of the client.

See also: IoT::OPC::IOPCClient::state()

writeAccessLevel virtual inline

virtual void writeAccessLevel(
    const std::string & nodeId,
    Poco::UInt8 accessLevel
);

Writes the Access Level attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeAccessLevel()

writeArrayDimensions virtual inline

virtual void writeArrayDimensions(
    const std::string & nodeId,
    const std::vector < Poco::UInt32 > & arrayDimensions
);

Writes the Array Dimensions attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeArrayDimensions()

writeBooleanArray virtual inline

virtual void writeBooleanArray(
    const std::string & nodeId,
    const std::vector < bool > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of Boolean.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeBooleanArray()

writeBooleanValue virtual inline

virtual void writeBooleanValue(
    const std::string & nodeId,
    bool value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Boolean.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeBooleanValue()

writeBrowseName virtual inline

virtual void writeBrowseName(
    const std::string & nodeId,
    const IoT::OPC::QualifiedName & qualifiedName
);

Writes the Browse Name attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeBrowseName()

writeByteArray virtual inline

virtual void writeByteArray(
    const std::string & nodeId,
    const std::vector < Poco::UInt8 > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of Byte.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeByteArray()

writeByteStringArray virtual inline

virtual void writeByteStringArray(
    const std::string & nodeId,
    const std::vector < std::vector < char >> & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of ByteString.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeByteStringArray()

writeByteStringValue virtual inline

virtual void writeByteStringValue(
    const std::string & nodeId,
    const std::vector < char > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be ByteString.

Throws a OPCTypeMismatch exception if the actual value's type does not match the expected type.

See also: IoT::OPC::IOPCClient::writeByteStringValue()

writeByteValue virtual inline

virtual void writeByteValue(
    const std::string & nodeId,
    Poco::UInt8 value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Byte.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeByteValue()

writeDataType virtual inline

virtual void writeDataType(
    const std::string & nodeId,
    const std::string & dataTypeId
);

Writes Data Type attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeDataType()

writeDateTimeArray virtual inline

virtual void writeDateTimeArray(
    const std::string & nodeId,
    const std::vector < Poco::DateTime > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of DateTime.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeDateTimeArray()

writeDateTimeValue virtual inline

virtual void writeDateTimeValue(
    const std::string & nodeId,
    const Poco::DateTime & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be DateTime.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeDateTimeValue()

writeDescription virtual inline

virtual void writeDescription(
    const std::string & nodeId,
    const IoT::OPC::LocalizedText & description
);

Writes the Description attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeDescription()

writeDisplayName virtual inline

virtual void writeDisplayName(
    const std::string & nodeId,
    const IoT::OPC::LocalizedText & displayName
);

Writes the Display Name attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeDisplayName()

writeDoubleArray virtual inline

virtual void writeDoubleArray(
    const std::string & nodeId,
    const std::vector < double > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of Double.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeDoubleArray()

writeDoubleValue virtual inline

virtual void writeDoubleValue(
    const std::string & nodeId,
    double value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Double.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeDoubleValue()

writeEventNotifier virtual inline

virtual void writeEventNotifier(
    const std::string & nodeId,
    Poco::UInt8 eventNotifier
);

Writes the Event Notifier attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeEventNotifier()

writeExecutable virtual inline

virtual void writeExecutable(
    const std::string & nodeId,
    bool executable
);

Writes the Executable attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeExecutable()

writeFloatArray virtual inline

virtual void writeFloatArray(
    const std::string & nodeId,
    const std::vector < float > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of Float.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeFloatArray()

writeFloatValue virtual inline

virtual void writeFloatValue(
    const std::string & nodeId,
    float value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Float.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeFloatValue()

writeGUIDArray virtual inline

virtual void writeGUIDArray(
    const std::string & nodeId,
    const std::vector < Poco::UUID > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of GUID (UUID).

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeGUIDArray()

writeGUIDValue virtual inline

virtual void writeGUIDValue(
    const std::string & nodeId,
    const Poco::UUID & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be GUID (UUID).

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeGUIDValue()

writeHistorizing virtual inline

virtual void writeHistorizing(
    const std::string & nodeId,
    bool historizing
);

Writes the Historizing attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeHistorizing()

writeInt16Array virtual inline

virtual void writeInt16Array(
    const std::string & nodeId,
    const std::vector < Poco::Int16 > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of Int16.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeInt16Array()

writeInt16Value virtual inline

virtual void writeInt16Value(
    const std::string & nodeId,
    Poco::Int16 value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Int16.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeInt16Value()

writeInt32Array virtual inline

virtual void writeInt32Array(
    const std::string & nodeId,
    const std::vector < Poco::Int32 > & value
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be Array of Int32.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeInt32Array()

writeInt32Value virtual inline

virtual void writeInt32Value(
    const std::string & nodeId,
    Poco::Int32 value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Int32.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeInt32Value()

writeInt64Array virtual inline

virtual void writeInt64Array(
    const std::string & nodeId,
    const std::vector < Poco::Int64 > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of Int64.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeInt64Array()

writeInt64Value virtual inline

virtual void writeInt64Value(
    const std::string & nodeId,
    Poco::Int64 value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Int64.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeInt64Value()

writeInverseName virtual inline

virtual void writeInverseName(
    const std::string & nodeId,
    const IoT::OPC::LocalizedText & inverseName
);

Writes the Inverse Name attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeInverseName()

writeIsAbstract virtual inline

virtual void writeIsAbstract(
    const std::string & nodeId,
    bool isAbstract
);

Writes the Is Abstract attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeIsAbstract()

writeMinimumSamplingInterval virtual inline

virtual void writeMinimumSamplingInterval(
    const std::string & nodeId,
    double minimumSamplingInterval
);

Writes the Minimum Sampling Interval attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeMinimumSamplingInterval()

writeNoLoops virtual inline

virtual void writeNoLoops(
    const std::string & nodeId,
    bool noLoops
);

Writes the No Loops attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeNoLoops()

writeNodeClass virtual inline

virtual void writeNodeClass(
    const std::string & nodeId,
    const IoT::OPC::NodeClass & nodeClass
);

Writes the Node Class attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeNodeClass()

writeNodeId virtual inline

virtual void writeNodeId(
    const std::string & nodeId,
    const std::string & newNodeId
);

Writes the Node ID attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeNodeId()

writeSByteArray virtual inline

virtual void writeSByteArray(
    const std::string & nodeId,
    const std::vector < Poco::Int8 > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of SByte.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeSByteArray()

writeSByteValue virtual inline

virtual void writeSByteValue(
    const std::string & nodeId,
    Poco::Int8 value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be SByte.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeSByteValue()

writeStringArray virtual inline

virtual void writeStringArray(
    const std::string & nodeId,
    const std::vector < std::string > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of String.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeStringArray()

writeStringValue virtual inline

virtual void writeStringValue(
    const std::string & nodeId,
    const std::string & value
);

Reads and returns the Value attribute of the node identified by nodeId. The value's type must be String.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeStringValue()

writeSymmetric virtual inline

virtual void writeSymmetric(
    const std::string & nodeId,
    bool symmetric
);

Writes the Symmetric attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeSymmetric()

writeUInt16Array virtual inline

virtual void writeUInt16Array(
    const std::string & nodeId,
    const std::vector < Poco::UInt16 > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of UInt16.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeUInt16Array()

writeUInt16Value virtual inline

virtual void writeUInt16Value(
    const std::string & nodeId,
    Poco::UInt16 value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be UInt16.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeUInt16Value()

writeUInt32Array virtual inline

virtual void writeUInt32Array(
    const std::string & nodeId,
    const std::vector < Poco::UInt32 > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of UInt32.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeUInt32Array()

writeUInt32Value virtual inline

virtual void writeUInt32Value(
    const std::string & nodeId,
    Poco::UInt32 value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be UInt32.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeUInt32Value()

writeUInt64Array virtual inline

virtual void writeUInt64Array(
    const std::string & nodeId,
    const std::vector < Poco::UInt64 > & value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be Array of UInt64.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeUInt64Array()

writeUInt64Value virtual inline

virtual void writeUInt64Value(
    const std::string & nodeId,
    Poco::UInt64 value
);

Writes the Value attribute of the node identified by nodeId. The value's type must be UInt64.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeUInt64Value()

writeUserAccessLevel virtual inline

virtual void writeUserAccessLevel(
    const std::string & nodeId,
    Poco::UInt8 userAccessLevel
);

Writes the User Access Level attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeUserAccessLevel()

writeUserExecutable virtual inline

virtual void writeUserExecutable(
    const std::string & nodeId,
    bool userExecutable
);

Writes the User Executable attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeUserExecutable()

writeUserWriteMask virtual inline

virtual void writeUserWriteMask(
    const std::string & nodeId,
    Poco::UInt32 userWriteMask
);

Writes the User Write Mask attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeUserWriteMask()

writeValueRank virtual inline

virtual void writeValueRank(
    const std::string & nodeId,
    Poco::Int32 valueRank
);

Writes the Value Rank attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeValueRank()

writeWriteMask virtual inline

virtual void writeWriteMask(
    const std::string & nodeId,
    Poco::UInt32 writeMask
);

Writes the Write Mask attribute of the node identified by nodeId.

Throws an OPCException if the attribute cannot be written.

See also: IoT::OPC::IOPCClient::writeWriteMask()

Securely control IoT edge devices from anywhere   Connect a Device