FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoGeometryStreamReader Class Reference

#include <GeometryStreamReader.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoGeometryStreamReader:

[legend]
List of all members.

Detailed Description

The FdoGeometryStreamReader class is a reader for serialized geometric data (abstract). The data source is defined by the implementation. FdoGeometryStreamReader is a helper type and does not inherit from FdoIGeometry.

Definition at line 37 of file GeometryStreamReader.h.


Public Member Functions

virtual FDO_GEOM_API FdoByteArrayGetData ()=0
 Gets an array representing the entire serialized Geometry.
virtual FDO_GEOM_API FdoGeometryStreamFactoryGetFactory ()=0
 Gets a factory object that can create more streams of the same implementation type as this object.
virtual FDO_GEOM_API FdoInt32 GetLength ()=0
 Gets the amount of data in the array returned by GetData(), in bytes.
virtual FDO_GEOM_API FdoByte ReadByte ()=0
 Reads one byte from the stream.
virtual FDO_GEOM_API FdoIDirectPositionReadDirectPosition (FdoInt32 dimension)=0
 Reads a geometric position with the given dimensionality from the stream.
virtual FDO_GEOM_API void ReadDirectPositionByMembers (FdoInt32 dimensionality, double *x, double *y, double *z, double *m)=0
 Reads a geometric position with the given dimensionality from the stream, by value of its ordinates (for performance).
virtual FDO_GEOM_API double ReadDouble ()=0
 Reads one number as a "double" from current position in the stream.
virtual FDO_GEOM_API FdoInt32 ReadInt ()=0
 Reads one number as a "FdoInt32" from the stream.
virtual FDO_GEOM_API void Reset ()=0
 Resets the current position to the beginning of the stream.
virtual FDO_GEOM_API void SetData (const FdoByte *data, FdoInt32 count)=0
 Sets the array used by the reader.
virtual FDO_GEOM_API void SetData (FdoByteArray *data)=0
 Sets the array used by the reader.
virtual FDO_GEOM_API void SkipBytes (FdoInt32 count)=0
 Advances the current position by skipping past bytes.
virtual FDO_GEOM_API void SkipDirectPositions (FdoInt32 dimension, FdoInt32 count)=0
 Advances the current position by skipping past geometric positions with the given dimension.
virtual FDO_GEOM_API void SkipDoubles (FdoInt32 count)=0
 Advances the current position by skipping past doubles.
virtual FDO_GEOM_API void SkipInts (FdoInt32 count)=0
 Advances the current position by skipping past integers.

Protected Member Functions

FDO_GEOM_API FdoGeometryStreamReader ()
 Constructs a default instance of a FdoGeometryStreamReader.
virtual FDO_GEOM_API ~FdoGeometryStreamReader ()
 Default destructor.

Constructor & Destructor Documentation

FDO_GEOM_API FdoGeometryStreamReader::FdoGeometryStreamReader  )  [inline, protected]
 

Constructs a default instance of a FdoGeometryStreamReader.

Returns:
Returns nothing

Definition at line 218 of file GeometryStreamReader.h.

References FDO_GEOM_API.

virtual FDO_GEOM_API FdoGeometryStreamReader::~FdoGeometryStreamReader  )  [inline, protected, virtual]
 

Default destructor.

Returns:
Returns nothing

Definition at line 226 of file GeometryStreamReader.h.

References FDO_GEOM_API.


Member Function Documentation

virtual FDO_GEOM_API FdoByteArray* FdoGeometryStreamReader::GetData  )  [pure virtual]
 

Gets an array representing the entire serialized Geometry.

Returns:
Returns the byte array

virtual FDO_GEOM_API FdoGeometryStreamFactory* FdoGeometryStreamReader::GetFactory  )  [pure virtual]
 

Gets a factory object that can create more streams of the same implementation type as this object.

Returns:
Returns A Geometry stream factory

virtual FDO_GEOM_API FdoInt32 FdoGeometryStreamReader::GetLength  )  [pure virtual]
 

Gets the amount of data in the array returned by GetData(), in bytes.

Returns:
Returns the number of bytes of Geometry data

virtual FDO_GEOM_API FdoByte FdoGeometryStreamReader::ReadByte  )  [pure virtual]
 

Reads one byte from the stream.

Returns:
Returns The next byte in the stream

virtual FDO_GEOM_API FdoIDirectPosition* FdoGeometryStreamReader::ReadDirectPosition FdoInt32  dimension  )  [pure virtual]
 

Reads a geometric position with the given dimensionality from the stream.

Returns:
Returns The numbers in the stream as a FdoIDirectPosition

virtual FDO_GEOM_API void FdoGeometryStreamReader::ReadDirectPositionByMembers FdoInt32  dimensionality,
double *  x,
double *  y,
double *  z,
double *  m
[pure virtual]
 

Reads a geometric position with the given dimensionality from the stream, by value of its ordinates (for performance).

Parameters:
dimensionality Input Dimensionality of ordinates in this position.
x Output X ordinate value.
y Output Y ordinate value.
z Output Z ordinate value.
m Output M ordinate value.
Returns:
Returns nothing

virtual FDO_GEOM_API double FdoGeometryStreamReader::ReadDouble  )  [pure virtual]
 

Reads one number as a "double" from current position in the stream.

Returns:
Returns The next number in the stream

virtual FDO_GEOM_API FdoInt32 FdoGeometryStreamReader::ReadInt  )  [pure virtual]
 

Reads one number as a "FdoInt32" from the stream.

Returns:
Returns The next number in the stream

virtual FDO_GEOM_API void FdoGeometryStreamReader::Reset  )  [pure virtual]
 

Resets the current position to the beginning of the stream.

Returns:
Returns nothing

virtual FDO_GEOM_API void FdoGeometryStreamReader::SetData const FdoByte data,
FdoInt32  count
[pure virtual]
 

Sets the array used by the reader.

Parameters:
data Input array data
count Input number of bytes in the array The caller must guarantee the validity of the array for the lifetime of the associated geometry stream.
Returns:
Returns nothing

virtual FDO_GEOM_API void FdoGeometryStreamReader::SetData FdoByteArray data  )  [pure virtual]
 

Sets the array used by the reader.

Parameters:
data Input array object
Returns:
Returns nothing

virtual FDO_GEOM_API void FdoGeometryStreamReader::SkipBytes FdoInt32  count  )  [pure virtual]
 

Advances the current position by skipping past bytes.

Parameters:
count Input number of bytes to skip
Returns:
Returns nothing

virtual FDO_GEOM_API void FdoGeometryStreamReader::SkipDirectPositions FdoInt32  dimension,
FdoInt32  count
[pure virtual]
 

Advances the current position by skipping past geometric positions with the given dimension.

Parameters:
dimension Input dimensionality of the positions (see FdoDimensionality)
count Input number of positions to skip
Returns:
Returns nothing

virtual FDO_GEOM_API void FdoGeometryStreamReader::SkipDoubles FdoInt32  count  )  [pure virtual]
 

Advances the current position by skipping past doubles.

Parameters:
count Input number of doubles to skip
Returns:
Returns nothing

virtual FDO_GEOM_API void FdoGeometryStreamReader::SkipInts FdoInt32  count  )  [pure virtual]
 

Advances the current position by skipping past integers.

Parameters:
count Input number of integers to skip
Returns:
Returns nothing

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.