eva::OID Class Reference

#include <eva4-ffi-sdk.hpp>

Public Member Functions
	OID (string s)
	OID (string s, bool fromPath)
string	fullId ()
void	markOk ()
void	markError ()
template<typename T >
void	setState (T value)
bool	operator== (const OID &other) const

Public Attributes
vars::ItemKind	kind
string	i
string	path
string	rawTopic

Detailed Description

The primary OID class

Constructor & Destructor Documentation

OID() [1/2]

eva::OID::OID ( string  s )

inline

Constructs OID from a string

Parameters

s	OID string

Exceptions

Exception

OID() [2/2]

eva::OID::OID ( string  s, bool  fromPath  )

inline

Constructs OID from a string or a path

Parameters

s	OID string or path
fromPath	true if the string is a path

Exceptions

Exception

Member Function Documentation

fullId()

string eva::OID::fullId ( )

inline

Gets item full id (without a kind)

Returns

item full id

markError()

void eva::OID::markError ( )

inline

Sets item status to -1 (ERROR) for the current OID

Exceptions

Exception

markOk()

void eva::OID::markOk ( )

inline

Sets item status to 1 (OK) for the current OID

Exceptions

Exception

setState()

template<typename T >

void eva::OID::setState ( T  value )

inline

Sets item state to status=1 (OK) and the specified value

Template Parameters

T	item value kind

Parameters

value

item value

Exceptions

Exception

Member Data Documentation

i

string eva::OID::i

OID as string

kind

vars::ItemKind eva::OID::kind

item kind

path

string eva::OID::path

OID as path

rawTopic

string eva::OID::rawTopic

item raw state bus topic for the current OID

---

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

• sdk/eva4-ffi-sdk.hpp