 |
openDAQ
Open data acquisition platform
|
|
openDAQ
Open data acquisition platform
|
A basic signal reader that simplifies accessing the signals's data stream. More...
Inheritance diagram for IReader: Collaboration diagram for IReader:A basic signal reader that simplifies accessing the signals's data stream.
Public Member Functions | |
| virtual ErrCode INTERFACE_FUNC | getAvailableCount (SizeT *count)=0 |
| Gets the number of segments available to read. More... | |
| virtual ErrCode INTERFACE_FUNC | setOnDataAvailable (IProcedure *callback)=0 |
| Sets the specified callback function to be called when there is available data in the reader. More... | |
| virtual ErrCode INTERFACE_FUNC | setExternalListener (IInputPortNotifications *listener)=0 |
| Sets an external listener to the reader. More... | |
| virtual ErrCode INTERFACE_FUNC | getEmpty (Bool *empty)=0 |
| Checks if there is data to read. 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... | |
|
pure virtual |
Gets the number of segments available to read.
| [out] | count | The number of available segments |
|
pure virtual |
Checks if there is data to read.
| [out] | empty | Set to true if there is data to read, false otherwise. |
This method returns true if there is data available to read. The data can be an event packet or a sufficient amount of data samples for minimum reading.
|
pure virtual |
Sets an external listener to the reader.
| listener | The external listener. |
When an external listener is set, after the reader is done processing the input port notification methods, it also calls the methods of the external listener.
|
pure virtual |
Sets the specified callback function to be called when there is available data in the reader.
| callback | The callback function to be set or nullptr to unset it. |
Pass nullptr to unset the callback. The callback should take no arguments.
1.9.1 
