openDAQ
Open data acquisition platform
ComponentStatusContainerPtr Class Reference

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

Inherits ObjectPtr< 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

daq::EnumerationPtr getStatus (const daq::StringPtr &name) const
 Gets the the current value of Component status with a given name. More...
 
daq::DictPtr< daq::IString, daq::IEnumeration > getStatuses () const
 Gets the current values of all Component statuses. More...
 

Member Function Documentation

◆ getStatus()

daq::EnumerationPtr getStatus ( const daq::StringPtr &  name) const
inline

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

Parameters
nameThe name of Component status.
Returns
The current value of Component status.

◆ getStatuses()

daq::DictPtr<daq::IString, daq::IEnumeration> getStatuses ( ) const
inline

Gets the current values of all Component statuses.

Returns
The Component statuses as a dictionary.

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