openDAQ
Open data acquisition platform
IInspectable Struct Referenceabstract

Provides introspection into the object providing openDAQ interface implementations. More...

+ Inheritance diagram for IInspectable:
+ Collaboration diagram for IInspectable:

Detailed Description

Provides introspection into the object providing openDAQ interface implementations.

Public Member Functions

virtual ErrCode INTERFACE_FUNC getInterfaceIds (SizeT *idCount, IntfID **ids)=0
 Retrieves the Ids of interfaces this object implements. To find out the number of interfaces implemented and the needed size of the ids you can first call the function with the ids as nullptr which will then only return the size over the idCount parameter. More...
 
virtual ErrCode INTERFACE_FUNC getRuntimeClassName (IString **implementationName)=0
 Gets the fully qualified name of the openDAQ object providing the implementation. 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

◆ getInterfaceIds()

virtual ErrCode INTERFACE_FUNC getInterfaceIds ( SizeT *  idCount,
IntfID **  ids 
)
pure virtual

Retrieves the Ids of interfaces this object implements. To find out the number of interfaces implemented and the needed size of the ids you can first call the function with the ids as nullptr which will then only return the size over the idCount parameter.

Parameters
[out]idCountThe number of interfaces implemented.
[out]idsThe interface ids represented as an IntfID struct, if nullptr it is not populated.

◆ getRuntimeClassName()

virtual ErrCode INTERFACE_FUNC getRuntimeClassName ( IString **  implementationName)
pure virtual

Gets the fully qualified name of the openDAQ object providing the implementation.

Parameters
implementationNameThe actual implementation class name.