openDAQ
Open data acquisition platform
IComponentStatusContainer Struct Referenceabstract

A container of Component Statuses and their corresponding values. More...

+ Inheritance diagram for IComponentStatusContainer:
+ Collaboration diagram for IComponentStatusContainer:

Detailed Description

A container of Component Statuses and their corresponding values.

Each status has a unique name and represents an actual status related to the openDAQ Component, such as connection status, synchronization status, etc. The statuses' values are represented by Enumeration objects.

Public Member Functions

virtual ErrCode INTERFACE_FUNC getStatus (IString *name, IEnumeration **value)=0
 Gets the the current value of Component status with a given name. More...
 
virtual ErrCode INTERFACE_FUNC getStatuses (IDict **statuses)=0
 Gets the current values of all Component statuses. More...
 
- Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC borrowInterface (const IntfID &intfID, void **obj) const =0
 Returns another interface which is supported by the object without incrementing the reference count. More...
 
virtual ErrCode INTERFACE_FUNC dispose ()=0
 Disposes all references held by the object. More...
 
virtual ErrCode INTERFACE_FUNC getHashCode (SizeT *hashCode)=0
 Returns hash code of the object. More...
 
virtual ErrCode INTERFACE_FUNC equals (IBaseObject *other, Bool *equal) const =0
 Compares object to another object for equality. More...
 
virtual ErrCode INTERFACE_FUNC toString (CharPtr *str)=0
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC queryInterface (const IntfID &intfID, void **obj)=0
 Returns another interface which is supported by the object and increments the reference count. More...
 
virtual int INTERFACE_FUNC addRef ()=0
 Increments the reference count for an interface on an object. More...
 
virtual int INTERFACE_FUNC releaseRef ()=0
 Decrements the reference count for an interface on an object. More...
 

Member Function Documentation

◆ getStatus()

virtual ErrCode INTERFACE_FUNC getStatus ( IString name,
IEnumeration **  value 
)
pure virtual

Gets the the current value of Component status with a given name.

Parameters
nameThe name of Component status.
[out]valueThe current value of Component status.

◆ getStatuses()

virtual ErrCode INTERFACE_FUNC getStatuses ( IDict **  statuses)
pure virtual

Gets the current values of all Component statuses.

Parameters
[out]statusesThe Component statuses as a dictionary.

All objects in the statuses dictionary are key value pairs of <IString, IEnumeration>.