openDAQ
Open data acquisition platform
IModuleInfo Struct Referenceabstract

Give module information composing of: More...

+ Inheritance diagram for IModuleInfo:
+ Collaboration diagram for IModuleInfo:

Detailed Description

Give module information composing of:

  • version info (major, minor, patch)
  • name
  • id.

Public Member Functions

virtual ErrCode INTERFACE_FUNC getVersionInfo (IVersionInfo **version)=0
 Retrieves the module version information. More...
 
virtual ErrCode INTERFACE_FUNC getName (IString **name)=0
 Gets the module name. More...
 
virtual ErrCode INTERFACE_FUNC getId (IString **id)=0
 Gets the module id. 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

◆ getId()

virtual ErrCode INTERFACE_FUNC getId ( IString **  id)
pure virtual

Gets the module id.

Parameters
[out]idThe module id.

◆ getName()

virtual ErrCode INTERFACE_FUNC getName ( IString **  name)
pure virtual

Gets the module name.

Parameters
[out]nameThe module name.

◆ getVersionInfo()

virtual ErrCode INTERFACE_FUNC getVersionInfo ( IVersionInfo **  version)
pure virtual

Retrieves the module version information.

Parameters
[out]versionThe semantic version information.