openDAQ
Open data acquisition platform
IComponentPrivate Struct Referenceabstract

Provides access to private methods of the component. More...

+ Inheritance diagram for IComponentPrivate:
+ Collaboration diagram for IComponentPrivate:

Detailed Description

Provides access to private methods of the component.

Said methods allow for triggering a Core event of the component, and locking/unlocking attributes of the component.

Public Member Functions

virtual ErrCode INTERFACE_FUNC lockAttributes (IList *attributes)=0
 Locks the attributes contained in the provided list. More...
 
virtual ErrCode INTERFACE_FUNC lockAllAttributes ()=0
 Locks all attributes of the component.
 
virtual ErrCode INTERFACE_FUNC unlockAttributes (IList *attributes)=0
 Unlocks the attributes contained in the provided list. More...
 
virtual ErrCode INTERFACE_FUNC unlockAllAttributes ()=0
 Unlocks all attributes of the component.
 
virtual ErrCode INTERFACE_FUNC triggerComponentCoreEvent (ICoreEventArgs *args)=0
 Triggers the component-specific core event with the provided arguments. 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

◆ lockAttributes()

virtual ErrCode INTERFACE_FUNC lockAttributes ( IList attributes)
pure virtual

Locks the attributes contained in the provided list.

Parameters
attributesThe list of attributes that should be locked. Is not case sensitive.

◆ triggerComponentCoreEvent()

virtual ErrCode INTERFACE_FUNC triggerComponentCoreEvent ( ICoreEventArgs args)
pure virtual

Triggers the component-specific core event with the provided arguments.

Parameters
argsThe arguments of the core event.

◆ unlockAttributes()

virtual ErrCode INTERFACE_FUNC unlockAttributes ( IList attributes)
pure virtual

Unlocks the attributes contained in the provided list.

Parameters
attributesThe list of attributes that should be unlocked. Is not case sensitive.