HydroCouple  1.0.0
Description of the HydroCouple Component-Based Model Coupling Interface Definitions
HydroCouple::Spatial::IRasterBand Class Referenceabstract

IRasterBand is a single raster band for an IRaster. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IRasterBand:
Collaboration diagram for HydroCouple::Spatial::IRasterBand:

Public Member Functions

virtual ~IRasterBand ()
 
virtual int xSize () const =0
 Number of pixels in the x direction. More...
 
virtual int ySize () const =0
 Number of pixels in y direction. More...
 
virtual IRasterraster () const =0
 Parent IRaster of this IRasterBand. More...
 
virtual IRaster::RasterDataType dataType () const =0
 Raster data type. More...
 
virtual void read (int xOffset, int yOffset, int xSize, int ySize, void *image) const =0
 Reads data into the image block. More...
 
virtual void write (int xOffset, int yOffset, int xSize, int ySize, const void *image)=0
 Writes image into the raster band. More...
 
virtual double noData () const =0
 
- Public Member Functions inherited from HydroCouple::IIdentity
virtual ~IIdentity ()
 
virtual QString id () const =0
 Gets a unique identifier for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IDescription
virtual ~IDescription ()
 
virtual QString caption () const =0
 Gets caption for the entity. More...
 
virtual void setCaption (const QString &caption)=0
 Sets caption for the entity. More...
 
virtual QString description () const =0
 Gets additional descriptive information for the entity. More...
 
virtual void setDescription (const QString &description)=0
 Gets additional descriptive information for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual ~IPropertyChanged ()
 

Additional Inherited Members

- Signals inherited from HydroCouple::IPropertyChanged
virtual void propertyChanged (const QString &propertyName)=0
 IPropertyChanged::propertyChanged() is called to emit signal/event when property of child class changes. More...
 

Detailed Description

IRasterBand is a single raster band for an IRaster.

Constructor & Destructor Documentation

virtual HydroCouple::Spatial::IRasterBand::~IRasterBand ( )
inlinevirtual

Member Function Documentation

virtual IRaster::RasterDataType HydroCouple::Spatial::IRasterBand::dataType ( ) const
pure virtual

Raster data type.

virtual double HydroCouple::Spatial::IRasterBand::noData ( ) const
pure virtual

The nodata value for this IRasterBand.

virtual IRaster* HydroCouple::Spatial::IRasterBand::raster ( ) const
pure virtual

Parent IRaster of this IRasterBand.

virtual void HydroCouple::Spatial::IRasterBand::read ( int  xOffset,
int  yOffset,
int  xSize,
int  ySize,
void *  image 
) const
pure virtual

Reads data into the image block.

Parameters
xOffsetis the pixel offset to the top left corner of the region of the band to be accessed. This would be zero to start from the left side.
Parameters
yOffsetis the line offset to the top left corner of the region of the band to be accessed. This would be zero to start from the top.
Parameters
xSizeis the width of the region of the band to be accessed in pixels.
Parameters
ySizeis the height of the region of the band to be accessed in lines.
Parameters
imageis the pointer to where data is to be written. Delete after use.
virtual void HydroCouple::Spatial::IRasterBand::write ( int  xOffset,
int  yOffset,
int  xSize,
int  ySize,
const void *  image 
)
pure virtual

Writes image into the raster band.

Parameters
xOffsetis the pixel offset to the top left corner of the region of the band to be accessed. This would be zero to start from the left side.
Parameters
yOffsetis the line offset to the top left corner of the region of the band to be accessed. This would be zero to start from the top.
Parameters
xSizeis the width of the region of the band to be accessed in pixels.
Parameters
ySizeis the height of the region of the band to be accessed in lines.
Parameters
imageis the pointer to where data is to be written. Delete after use.
virtual int HydroCouple::Spatial::IRasterBand::xSize ( ) const
pure virtual

Number of pixels in the x direction.

virtual int HydroCouple::Spatial::IRasterBand::ySize ( ) const
pure virtual

Number of pixels in y direction.


The documentation for this class was generated from the following file: