IComponentStatusContainerPrivate Struct Reference

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

Inheritance diagram for IComponentStatusContainerPrivate:

Collaboration diagram for 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
virtual ErrCode INTERFACE_FUNC	addStatus (IString *name, IEnumeration *initialValue)=0
	Adds the new status with given name and initial value. More...
virtual ErrCode INTERFACE_FUNC	setStatus (IString *name, IEnumeration *value)=0
	Sets the value for the existing component status. More...
virtual ErrCode INTERFACE_FUNC	addStatusWithMessage (IString *name, IEnumeration *initialValue, IString *message)=0
	Adds the new status with given name, initial value, and message. More...
virtual ErrCode INTERFACE_FUNC	setStatusWithMessage (IString *name, IEnumeration *value, IString *message)=0
	Sets the value for the existing component status with a message. 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

addStatus()

virtual ErrCode INTERFACE_FUNC addStatus ( IString *  name, IEnumeration *  initialValue  )

pure virtual

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()

virtual ErrCode INTERFACE_FUNC addStatusWithMessage ( IString *  name, IEnumeration *  initialValue, IString *  message  )

pure virtual

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()

virtual ErrCode INTERFACE_FUNC setStatus ( IString *  name, IEnumeration *  value  )

pure virtual

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()

virtual ErrCode INTERFACE_FUNC setStatusWithMessage ( IString *  name, IEnumeration *  value, IString *  message  )

pure virtual

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.