ComponentStatusContainerPrivatePtr Class Reference

Provides access to private methods of the Component status container. More...

Inherits ObjectPtr< IComponentStatusContainerPrivate >.

Detailed Description

Provides access to private methods of the Component status container.

Said methods allow for adding new statuses and setting a value for existing statuses stored in the component status container. Device connection statuses, however, are managed independently via IConnectionStatusContainerPrivate.

"StatusChanged" Core events are triggered whenever there is a change in the status of the openDAQ Component.

Public Member Functions
void	addStatus (const daq::StringPtr &name, const daq::EnumerationPtr &initialValue) const
	Adds the new status with given name and initial value. More...
void	setStatus (const daq::StringPtr &name, const daq::EnumerationPtr &value) const
	Sets the value for the existing component status. More...
void	addStatusWithMessage (const daq::StringPtr &name, const daq::EnumerationPtr &initialValue, const daq::StringPtr &message) const
	Adds the new status with given name, initial value, and message. More...
void	setStatusWithMessage (const daq::StringPtr &name, const daq::EnumerationPtr &value, const daq::StringPtr &message) const
	Sets the value for the existing component status with a message. More...

Member Function Documentation

addStatus()

void addStatus ( const daq::StringPtr &  name, const daq::EnumerationPtr &  initialValue  ) const

inline

Adds the new status with given name and initial value.

Parameters

name	The name of the component status.
initialValue	The initial value of the component status.

addStatusWithMessage()

void addStatusWithMessage ( const daq::StringPtr &  name, const daq::EnumerationPtr &  initialValue, const daq::StringPtr &  message  ) const

inline

Adds the new status with given name, initial value, and message.

Parameters

name	The name of the component status.
initialValue	The initial value of the component status.
message	The message of the component status.

setStatus()

void setStatus ( const daq::StringPtr &  name, const daq::EnumerationPtr &  value  ) const

inline

Sets the value for the existing component status.

Parameters

name	The name of the component status.
value	The new value of the component status.

setStatusWithMessage()

void setStatusWithMessage ( const daq::StringPtr &  name, const daq::EnumerationPtr &  value, const daq::StringPtr &  message  ) const

inline

Sets the value for the existing component status with a message.

Parameters

name	The name of the component status.
value	The new value of the component status.
message	The new message of the component status.