Loading...
Searching...
No Matches
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 ()=default
 IRasterBand destructor.
 
virtual int64_t xSize () const =0
 Number of pixels in the x direction.
 
virtual int64_t 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 bool read (int64_t xOffset, int64_t yOffset, int64_t xSize, int64_t ySize, const BufferDescriptor &destination, std::string *message=nullptr) const =0
 Reads a window of the band into a caller-described buffer.
 
virtual bool write (int64_t xOffset, int64_t yOffset, int64_t xSize, int64_t ySize, const BufferDescriptor &source, std::string *message=nullptr)=0
 Writes a caller-described buffer into a window of the band.
 
virtual double noData () const =0
 The nodata value for this IRasterBand.
 
- 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
nodiscardpure virtual

Raster data type.

◆ noData()

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

The nodata value for this IRasterBand.

◆ raster()

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

Parent IRaster of this IRasterBand.

◆ read()

virtual bool HydroCouple::Spatial::IRasterBand::read ( int64_t xOffset,
int64_t yOffset,
int64_t xSize,
int64_t ySize,
const BufferDescriptor & destination,
std::string * message = nullptr ) const
nodiscardpure virtual

Reads a window of the band into a caller-described buffer.

The same data plane as IComponentDataItem::getValuesInto(): the destination is a rank-2 descriptor of shape {ySize, xSize} whose kind is the DataKind this band's dataType() maps to (see RasterDataType), and the same memory-space and contiguity rules apply.

Parameters
[in]xOffsetis the pixel offset to the top left corner of the window; zero starts at the left edge.
[in]yOffsetis the line offset to the top left corner of the window; zero starts at the top.
[in]xSizeis the width of the window in pixels.
[in]ySizeis the height of the window in lines.
[in]destinationdescribes the buffer receiving the window.
[out]messageoptionally receives a failure description.
Returns
True on success.
Here is the call graph for this function:

◆ write()

virtual bool HydroCouple::Spatial::IRasterBand::write ( int64_t xOffset,
int64_t yOffset,
int64_t xSize,
int64_t ySize,
const BufferDescriptor & source,
std::string * message = nullptr )
nodiscardpure virtual

Writes a caller-described buffer into a window of the band.

Rules as for read().

Parameters
[in]xOffsetis the pixel offset to the top left corner of the window.
[in]yOffsetis the line offset to the top left corner of the window.
[in]xSizeis the width of the window in pixels.
[in]ySizeis the height of the window in lines.
[in]sourcedescribes the buffer providing the window.
[out]messageoptionally receives a failure description.
Returns
True on success.
Here is the call graph for this function:

◆ xSize()

virtual int64_t HydroCouple::Spatial::IRasterBand::xSize ( ) const
nodiscardpure virtual

Number of pixels in the x direction.

Here is the caller graph for this function:

◆ ySize()

virtual int64_t HydroCouple::Spatial::IRasterBand::ySize ( ) const
nodiscardpure virtual

Number of pixels in y direction.

Here is the caller graph for this function:

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