Orion
high-rate readout
Classes | Public Member Functions | List of all members
itk::opc::Client Class Referenceabstract

OPC Client to communicate with OPC Server. More...

#include <client.hpp>

Classes

struct  Factory
 

Public Member Functions

virtual ~Client ()=default
 Default destructor.
 
virtual bool connect (std::string connstr)=0
 Connect to DCS using the connection string. More...
 
virtual bool disconnect ()=0
 Disconnect from DCS. More...
 
virtual std::vector< NodeIdget_nodes ()=0
 Get node objects available in DSC. More...
 
virtual Variant get_value (NodeId &nodeid)=0
 
virtual bool set_value (NodeId &nodeid, Variant value)=0
 

Detailed Description

OPC Client to communicate with OPC Server.

Member Function Documentation

◆ connect()

virtual bool itk::opc::Client::connect ( std::string  connstr)
pure virtual

Connect to DCS using the connection string.

Parameters
connstrthe connection string required to connect to DCS
Returns
true if connected, otherwie false

◆ disconnect()

virtual bool itk::opc::Client::disconnect ( )
pure virtual

Disconnect from DCS.

Returns
true if disconnected, otherwie false

◆ get_nodes()

virtual std::vector<NodeId> itk::opc::Client::get_nodes ( )
pure virtual

Get node objects available in DSC.

Returns
vector of NodeId objects

◆ get_value()

virtual Variant itk::opc::Client::get_value ( NodeId nodeid)
pure virtual

Retrieve the value of a node by nodeid.

Parameters
nodeidthe NodeId object
Returns
the Variant value of the node

◆ set_value()

virtual bool itk::opc::Client::set_value ( NodeId nodeid,
Variant  value 
)
pure virtual

Store the value to the node provided by nodeid

Parameters
nodeidthe NodeId of the node
valuethe Variant value of the node
Returns
true if stored, otherwie false

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