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

FdoRasterDataModel Class Reference

#include <RasterDataModel.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoRasterDataModel:

[legend]
List of all members.

Detailed Description

The FdoRasterDataModel specifies the data type and organization of raster data retrieved and stored. Using this class and the image extents in width and length, the binary format of the image data returned by and accepted by the FdoIStreamReader class can be interpreted.

Definition at line 34 of file RasterDataModel.h.


Public Member Functions

virtual FDO_API bool Equals (FdoRasterDataModel *pModel)
 Compares this raster data model with another one.
virtual FDO_API FdoInt32 GetBitsPerPixel ()
 Get the number of bits per pixel.
virtual FDO_API FdoRasterDataModelType GetDataModelType ()
 Gets the type of data available from this datamodel.
virtual FDO_API FdoRasterDataType GetDataType ()
 Gets the data type.
virtual FDO_API FdoRasterDataOrganization GetOrganization ()
 Get the data interleave organization.
virtual FDO_API FdoInt32 GetTileSizeX ()
 Get the tile size in the horizontal direction (number of columns).
virtual FDO_API FdoInt32 GetTileSizeY ()
 Get the tile size in the vertical direction (number of rows).
virtual FDO_API void SetBitsPerPixel (FdoInt32 bpp)
 Set the number of bits per pixel.
virtual FDO_API void SetDataModelType (FdoRasterDataModelType type)
 Sets the type of data for this datamodel.
virtual FDO_API void SetDataType (FdoRasterDataType dataType)
 Sets the data type.
virtual FDO_API void SetOrganization (FdoRasterDataOrganization organization)
 Set the data interleave organization.
virtual FDO_API void SetTileSizeX (FdoInt32 sizex)
 Set the tile size in the horizontal direction (number of columns).
virtual FDO_API void SetTileSizeY (FdoInt32 sizey)
 Set the tile size in the vertical direction (number of rows). Values of 64, 128, 256, 512, 1024 and the image extents in width and length may be supported. When the tile sizes are equal to the image extents, the image is monolithic. Rectangular tile sizes, combining different values for X and Y, may be supported.

Static Public Member Functions

FDO_API FdoRasterDataModelCreate ()
 Creates a new datamodel.

Protected Member Functions

virtual FDO_API void Dispose ()
 Dispose this object.
FDO_API FdoRasterDataModel ()

Protected Attributes

FdoInt32 m_BitsPerPixel
FdoRasterDataType m_DataType
FdoRasterDataOrganization m_Organization
FdoInt32 m_TileX
FdoInt32 m_TileY
FdoRasterDataModelType m_Type

Constructor & Destructor Documentation

FDO_API FdoRasterDataModel::FdoRasterDataModel  )  [protected]
 


Member Function Documentation

FDO_API FdoRasterDataModel* FdoRasterDataModel::Create  )  [static]
 

Creates a new datamodel.

Returns:
Returns a bitonal 256x256 tiled data model.

virtual FDO_API void FdoRasterDataModel::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

virtual FDO_API bool FdoRasterDataModel::Equals FdoRasterDataModel pModel  )  [virtual]
 

Compares this raster data model with another one.

Parameters:
pModel The Raster Data Model to compare with
Returns:
Returns true if this Raster Data Model is the same as pModel (all members have the same values).

virtual FDO_API FdoInt32 FdoRasterDataModel::GetBitsPerPixel  )  [virtual]
 

Get the number of bits per pixel.

Returns:
Returns the number of bits for each pixel. For multi-channel data the bits per channel will be this value devided by the numer of channels. For example, RGB data has three channels, so if this method returns twelve, each channel is four bits.

virtual FDO_API FdoRasterDataModelType FdoRasterDataModel::GetDataModelType  )  [virtual]
 

Gets the type of data available from this datamodel.

Returns:
Returns the type of data available with this data model.

virtual FDO_API FdoRasterDataType FdoRasterDataModel::GetDataType  )  [virtual]
 

Gets the data type.

Returns:
Returns the data type of the raster.

virtual FDO_API FdoRasterDataOrganization FdoRasterDataModel::GetOrganization  )  [virtual]
 

Get the data interleave organization.

Returns:
Returns the way data is interleaved.

virtual FDO_API FdoInt32 FdoRasterDataModel::GetTileSizeX  )  [virtual]
 

Get the tile size in the horizontal direction (number of columns).

Returns:
The number of columns in a tile.

virtual FDO_API FdoInt32 FdoRasterDataModel::GetTileSizeY  )  [virtual]
 

Get the tile size in the vertical direction (number of rows).

Returns:
The number of rows in a tile.

virtual FDO_API void FdoRasterDataModel::SetBitsPerPixel FdoInt32  bpp  )  [virtual]
 

Set the number of bits per pixel.

Parameters:
bpp The number of bits per pixel desired. Values of 1, 4, 8, 16, 24, 32, 48 and 64 bits per channel may be supported. Others values (i.e. indivisible by the number of channels) are likely to raise a FdoException.

virtual FDO_API void FdoRasterDataModel::SetDataModelType FdoRasterDataModelType  type  )  [virtual]
 

Sets the type of data for this datamodel.

Parameters:
type The type of data for this data model.

virtual FDO_API void FdoRasterDataModel::SetDataType FdoRasterDataType  dataType  )  [virtual]
 

Sets the data type.

Parameters:
dataType Specifies the data type the raster data is to be returned in.

virtual FDO_API void FdoRasterDataModel::SetOrganization FdoRasterDataOrganization  organization  )  [virtual]
 

Set the data interleave organization.

Parameters:
organization Specifies the way data is to be interleaved.

virtual FDO_API void FdoRasterDataModel::SetTileSizeX FdoInt32  sizex  )  [virtual]
 

Set the tile size in the horizontal direction (number of columns).

Parameters:
sizex The number of columns in a tile.

virtual FDO_API void FdoRasterDataModel::SetTileSizeY FdoInt32  sizey  )  [virtual]
 

Set the tile size in the vertical direction (number of rows). Values of 64, 128, 256, 512, 1024 and the image extents in width and length may be supported. When the tile sizes are equal to the image extents, the image is monolithic. Rectangular tile sizes, combining different values for X and Y, may be supported.

Parameters:
sizey The number of rows in a tile.

Member Data Documentation

FdoInt32 FdoRasterDataModel::m_BitsPerPixel [protected]
 

Definition at line 38 of file RasterDataModel.h.

FdoRasterDataType FdoRasterDataModel::m_DataType [protected]
 

Definition at line 42 of file RasterDataModel.h.

FdoRasterDataOrganization FdoRasterDataModel::m_Organization [protected]
 

Definition at line 39 of file RasterDataModel.h.

FdoInt32 FdoRasterDataModel::m_TileX [protected]
 

Definition at line 40 of file RasterDataModel.h.

FdoInt32 FdoRasterDataModel::m_TileY [protected]
 

Definition at line 41 of file RasterDataModel.h.

FdoRasterDataModelType FdoRasterDataModel::m_Type [protected]
 

Definition at line 37 of file RasterDataModel.h.


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