FDO API Reference | Feature Data Objects |
#include <ObjectStreamReader.h>
Inherits FdoIStreamReaderTmpl< T >< T >.
Inheritance diagram for FdoIoObjectStreamReader< T >:
Definition at line 29 of file ObjectStreamReader.h.
Public Member Functions | |
virtual FDO_API_COMMON FdoInt64 | GetIndex () |
Gets the current stream position. Position is measured by number of items from the stream start. | |
virtual FDO_API_COMMON FdoInt64 | GetLength () |
Gets the stream length. | |
virtual FDO_API_COMMON FdoInt32 | ReadNext (FdoArray< T > *&buffer, const FdoInt32 offset=0, const FdoInt32 count=-1) |
Reads in the next block of items. Use ReadNext( buffer) to read in the entire stream. The caller is responsible to create/dispose the FdoArray. | |
virtual FDO_API_COMMON FdoInt32 | ReadNext (T *buffer, const FdoInt32 offset=0, const FdoInt32 count=-1) |
Reads in the next block of items. Use ReadNext( buffer) to read in the entire stream. The caller is responsible to allocate a buffer large enough to store data. | |
virtual FDO_API_COMMON void | Reset () |
Reset the current index to the stream start. Allows re-reading. | |
virtual FDO_API_COMMON void | Skip (const FdoInt32 offset) |
Skips a number of items. | |
Protected Member Functions | |
FdoIoObjectStreamReader (FdoIoStream *stream) | |
FdoIoObjectStreamReader () | |
DOXYGEN-IGNORE | |
~FdoIoObjectStreamReader () |
|
DOXYGEN-IGNORE
Definition at line 249 of file ObjectStreamReader.h. |
|
Definition at line 251 of file ObjectStreamReader.h. |
|
Definition at line 257 of file ObjectStreamReader.h. |
|
Gets the current stream position. Position is measured by number of items from the stream start.
Implements FdoIStreamReaderTmpl< T >. Definition at line 66 of file ObjectStreamReader.h. Referenced by FdoIoObjectStreamReader< FdoByte >::ReadNext(). |
|
Gets the stream length.
Return the number of objects (floor if #bytes/object size) Partial objects at end of stream are ignored. Implements FdoIStreamReaderTmpl< T >. Definition at line 38 of file ObjectStreamReader.h. Referenced by FdoIoObjectStreamReader< FdoByte >::ReadNext(). |
|
Reads in the next block of items. Use ReadNext( buffer) to read in the entire stream. The caller is responsible to create/dispose the FdoArray.
Implements FdoIStreamReaderTmpl< T >. Definition at line 200 of file ObjectStreamReader.h. |
|
Reads in the next block of items. Use ReadNext( buffer) to read in the entire stream. The caller is responsible to allocate a buffer large enough to store data.
If the stream provides context information then calculate how many items are left to read. Items that will be read is lessor of items to read and items remaining. This ensures that we don't read any partial item at the end of the stream. Implements FdoIStreamReaderTmpl< T >. Definition at line 112 of file ObjectStreamReader.h. Referenced by FdoIoObjectStreamReader< FdoByte >::ReadNext(). |
|
Reset the current index to the stream start. Allows re-reading.
Implements FdoIStreamReaderTmpl< T >. Definition at line 88 of file ObjectStreamReader.h. |
|
Skips a number of items.
Implements FdoIStreamReaderTmpl< T >. Definition at line 54 of file ObjectStreamReader.h. |
Comments or suggestions? Send us feedback. |