IReaderStatus Struct Reference

Represents the status of the reading process returned by the reader::read function. More...

Inheritance diagram for IReaderStatus:

Collaboration diagram for IReaderStatus:

Detailed Description

Represents the status of the reading process returned by the reader::read function.

The IReaderStatus class provides information about the outcome of the reading operation, including the validity of the reader and the potential encounter of event packets during processing. Objects of this class are typically returned as a result of the read function of the Readers, allowing the client code to assess and respond to the status of the reading process.

Public Member Functions
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

getEventPacket()

virtual ErrCode INTERFACE_FUNC getEventPacket ( IEventPacket **  packet )

pure virtual

Retrieves the event packet from the reading process.

Parameters

[out]

packet

The event packet from the reading process.

getOffset()

virtual ErrCode INTERFACE_FUNC getOffset ( INumber **  offset )

pure virtual

Retrieves the offset of the the read values.

Parameters

[out]

offset

The offset of the read values

getReadStatus()

virtual ErrCode INTERFACE_FUNC getReadStatus ( ReadStatus *  status )

pure virtual

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.

Parameters

[out]

status

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

getValid()

virtual ErrCode INTERFACE_FUNC getValid ( Bool *  valid )

pure virtual

Checks the validity of the reader.

Parameters

[out]

valid

Boolean value indicating the validity of the reader