Block reader status

Collaboration diagram for Block reader status:

Detailed Description

Enumerations
enum class	ReadTimeoutType { Any , All }
	Controls how Reader read call time-outs are handled. More...

Functions
daq::SizeT	getReadSamples () const
	Returns the number of samples that were read. Sometimes, during the process of reading, an event packet may occur that stops the reading of remaining samples. Developers can use this function to determine how many samples were actually read. More...
daq::DictPtr< daq::IString, daq::IEventPacket >	getEventPackets () const
	Retrieves the dictionary of event packets from the reading process, ordered by signals. More...
daq::EventPacketPtr	getMainDescriptor () const
	Retrieves the descriptor of main signal. The main signal is the first signal in the list of signals. More...
daq::ReadStatus	getReadStatus () const
	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...
daq::EventPacketPtr	getEventPacket () const
	Retrieves the event packet from the reading process. More...
daq::Bool	getValid () const
	Checks the validity of the reader. More...
daq::NumberPtr	getOffset () const
	Retrieves the offset of the the read values. More...

Enumeration Type Documentation

ReadTimeoutType

enum ReadTimeoutType

strong

Controls how Reader read call time-outs are handled.

Enumerator
Any	When some segments are available return them immediately. When no segments are available return immediately when any arrive or time-out is exceeded.
All	Wait for the requested amount or until time-out is exceeded.

Function Documentation

getEventPacket()

daq::EventPacketPtr getEventPacket ( ) const

inline

Retrieves the event packet from the reading process.

Returns

The event packet from the reading process.

getEventPackets()

daq::DictPtr<daq::IString, daq::IEventPacket> getEventPackets ( ) const

inline

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

Returns

The dictionary with global id of input port and the corresponding event packet.

getMainDescriptor()

daq::EventPacketPtr getMainDescriptor ( ) const

inline

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

Returns

The descriptor of the main signal.

getOffset()

daq::NumberPtr getOffset ( ) const

inline

Retrieves the offset of the the read values.

Returns

The offset of the read values

getReadSamples()

daq::SizeT getReadSamples ( ) const

inline

Returns the number of samples that were read. Sometimes, during the process of reading, an event packet may occur that stops the reading of remaining samples. Developers can use this function to determine how many samples were actually read.

Parameters

[out]

samplesCount

the amount of samples that were read.

getReadStatus()

daq::ReadStatus getReadStatus ( ) const

inline

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.

Returns

a ReadStatus enum variable where the current reading status will be stored.

getValid()

daq::Bool getValid ( ) const

inline

Checks the validity of the reader.

Returns

Boolean value indicating the validity of the reader