HydroCouple::Spatial::IRasterBand Class Reference

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 ()=default
	IRasterBand destructor.
virtual int	xSize () const =0
	Number of pixels in the x direction.
virtual int	ySize () const =0
	Number of pixels in y direction.
virtual IRaster *	raster () const =0
	Parent IRaster of this IRasterBand.
virtual IRaster::RasterDataType	dataType () const =0
	Raster data type.
virtual void	read (int xOffset, int yOffset, int xSize, int ySize, void *image) const =0
	Reads data into the image block.
virtual void	write (int xOffset, int yOffset, int xSize, int ySize, const void *image)=0
	Writes image into the raster band.
virtual double	noData () const =0
Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=default
	IIdentity::~IIdentity is a virtual destructor.
virtual const std::string &	id () const =0
	Gets a unique identifier for the entity.
Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=default
	IDescription::~IDescription is a virtual destructor.
virtual const std::string &	caption () const =0
	Gets caption for the entity.
virtual void	setCaption (const std::string &caption)=0
	Sets caption for the entity.
virtual const std::string &	description () const =0
	Gets additional descriptive information for the entity.
virtual void	setDescription (const std::string &description)=0
	Gets additional descriptive information for the entity.
Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=default
	IPropertyChanged::~IPropertyChanged is a virtual destructor.
Public Member Functions inherited from HydroCouple::ISignal< std::string >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.
virtual void	connect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.
virtual void	disconnect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	disconnect is used to disconnect a slot from the signal.
virtual void	blockSignals (bool block)=0
	blockSignals is used to block signals from being emitted.

Additional Inherited Members
Protected Member Functions inherited from HydroCouple::ISignal< std::string >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

Detailed Description

IRasterBand is a single raster band for an IRaster.

Constructor & Destructor Documentation

~IRasterBand()

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

virtualdefault

IRasterBand destructor.

Member Function Documentation

dataType()

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

pure virtual

Raster data type.

noData()

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

pure virtual

The nodata value for this IRasterBand.

raster()

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

pure virtual

Parent IRaster of this IRasterBand.

read()

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

[in]	xOffset	is 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.
[in]	yOffset	is 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.
[in]	xSize	is the width of the region of the band to be accessed in pixels.
[in]	ySize	is the height of the region of the band to be accessed in lines.
[out]	image	is the pointer to where data is to be written. Must be pre-allocated with the correct size.

write()

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

[in]	xOffset	is 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.
[in]	yOffset	is 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.
[in]	xSize	is the width of the region of the band to be accessed in pixels.
[in]	ySize	is the height of the region of the band to be accessed in lines.
[in]	image	is the pointer to the image data to be written to the raster band.

xSize()

virtual int HydroCouple::Spatial::IRasterBand::xSize ( ) const

pure virtual

Number of pixels in the x direction.

ySize()

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:

• /home/runner/work/HydroCouple/HydroCouple/HydroCouple/include/hydrocouplespatial.h