openDAQ
Open data acquisition platform
ITagsPrivate Struct Referenceabstract

Private interface to component tags. Allows for adding/removing tags. More...

+ Inheritance diagram for ITagsPrivate:
+ Collaboration diagram for ITagsPrivate:

Detailed Description

Private interface to component tags. Allows for adding/removing tags.

Modifying the tags of a component might have unintended sideffects and should in most cases only be done by the component owner module.

Public Member Functions

virtual ErrCode INTERFACE_FUNC add (IString *name)=0
 Adds a new tag to the list. More...
 
virtual ErrCode INTERFACE_FUNC remove (IString *name)=0
 Removes a new tag from the list. More...
 
virtual ErrCode INTERFACE_FUNC replace (IList *tags)=0
 Replaces all tags. 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

◆ add()

virtual ErrCode INTERFACE_FUNC add ( IString name)
pure virtual

Adds a new tag to the list.

Parameters
nameThe name of the tag to be added.
Return values
OPENDAQ_IGNOREDif a node with the name is already in the list of tags.

◆ remove()

virtual ErrCode INTERFACE_FUNC remove ( IString name)
pure virtual

Removes a new tag from the list.

Parameters
nameThe name of the tag to be removed.
Return values
OPENDAQ_IGNOREDif a node with the name is not in the list of tags.

◆ replace()

virtual ErrCode INTERFACE_FUNC replace ( IList tags)
pure virtual

Replaces all tags.

Parameters
tagsThe new list of tags.