openDAQ
Open data acquisition platform
IMultiReaderStatus Struct Referenceabstract

IMultiReaderStatus inherits from IReaderStatus to expand information returned read function. More...

+ Inheritance diagram for IMultiReaderStatus:
+ Collaboration diagram for IMultiReaderStatus:

Detailed Description

IMultiReaderStatus inherits from IReaderStatus to expand information returned read function.

Public Member Functions

virtual ErrCode INTERFACE_FUNC getEventPackets (IDict **eventPackets)=0
 Retrieves the dictionary of event packets from the reading process, ordered by signals. More...
 
virtual ErrCode INTERFACE_FUNC getMainDescriptor (IEventPacket **descriptor)=0
 Retrieves the descriptor of main signal. The main signal is the first signal in the list of signals. More...
 
- Public Member Functions inherited from IReaderStatus
virtual ErrCode INTERFACE_FUNC getReadStatus (ReadStatus *status)=0
 Retrieves the current reading status, indicating whether the reading process is in an "Ok" state, has encountered an Event, has failed, or is in an Unknown state. More...
 
virtual ErrCode INTERFACE_FUNC getEventPacket (IEventPacket **packet)=0
 Retrieves the event packet from the reading process. More...
 
virtual ErrCode INTERFACE_FUNC getValid (Bool *valid)=0
 Checks the validity of the reader. More...
 
virtual ErrCode INTERFACE_FUNC getOffset (INumber **offset)=0
 Retrieves the offset of the the read values. 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

◆ getEventPackets()

virtual ErrCode INTERFACE_FUNC getEventPackets ( IDict **  eventPackets)
pure virtual

Retrieves the dictionary of event packets from the reading process, ordered by signals.

Parameters
[out]eventPacketsThe dictionary with global id of input port and the corresponding event packet.

◆ getMainDescriptor()

virtual ErrCode INTERFACE_FUNC getMainDescriptor ( IEventPacket **  descriptor)
pure virtual

Retrieves the descriptor of main signal. The main signal is the first signal in the list of signals.

Parameters
[out]descriptorThe descriptor of the main signal.