An IRasterComponentDataItem represents an IRaster IComponentItem. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IRasterComponentDataItem:

Collaboration diagram for HydroCouple::Spatial::IRasterComponentDataItem:

Public Member Functions
virtual	~IRasterComponentDataItem ()=0
	IRasterComponentItem destructor. More...

virtual IRaster *	raster () const =0
	IRaster associated with this IRasterComponentDataItem. More...

virtual IDimension *	xDimension () const =0
	IDimension for xDirection. More...

virtual IDimension *	yDimension () const =0
	IDimension for yDirection. More...

virtual IDimension *	bandDimension () const =0
	IDimension for IRasterBands. More...

virtual void	getValue (int xIndex, int yIndex, int band, void *data) const =0
	getValue for given x dimension index, y dimension index, and band dimension index. More...

virtual void	getValues (int xIndex, int yIndex, int band, int xStride, int yStride, void *data) const =0
	Gets a multi-dimensional array of values for given dimension for a hyperslab. More...

virtual void	setValue (int xIndex, int yIndex, int band, const void *data)=0
	setValue for given x dimension index, y dimension index, and band dimension index. More...

virtual void	setValues (int xIndex, int yIndex, int band, int xStride, int yStride, const void *data)=0
	Sets a multi-dimensional array of values for given dimension for a hyperslab. More...

Public Member Functions inherited from HydroCouple::IComponentDataItem
virtual	~IComponentDataItem ()=0
	IComponentDataItem::~IComponentDataItem is a virtual destructor. More...

virtual IModelComponent *	modelComponent () const =0
	Gets the owner IModelComponent of this IComponentItem. For an IOutput component item this is the component responsible for providing the content of the IOutput. More...

virtual vector< IDimension * >	dimensions () const =0
	provides purely descriptive information of the dimensions associated with this IComponentItem More...

virtual int	dimensionLength (const vector< int > &dimensionIndexes) const =0
	dimensionLength returns the length of the dimension specified by the given dimension indexes. To get the size of the first dimension, use a null integer array as input argument. Length of indices must be a least one smaller than the numDimensions() More...

virtual IValueDefinition *	valueDefinition () const =0
	IValueDefinition for this IValueSet defines the variable type associated with this object. More...

virtual void	getValue (const vector< int > &dimensionIndexes, void *data) const =0
	Gets a multi-dimensional array of value for given dimension indexes. IndexArray = x + y * InSizeX + z * InSizeX * InSizeY etc;. More...

virtual void	setValue (const vector< int > &dimensionIndexes, const void *data)=0
	Sets a multi-dimensional array of values for given dimension indexes. More...

virtual bool	hasEditor () const =0
	hasEditor indicates whether this IComponentItem has a UI editor. More...

virtual void	showEditor ()=0
	showEditor shows the editor for this IComponentItem. More...

virtual bool	hasViewer () const =0
	hasViewer indicates whether this IComponentItem has a UI viewer. More...

virtual void	showViewer ()=0
	showViewer More...

Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=0
	IIdentity::~IIdentity is a virtual destructor. More...

virtual string	id () const =0
	Gets a unique identifier for the entity. More...

Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=0
	IDescription::~IDescription is a virtual destructor. More...

virtual string	caption () const =0
	Gets caption for the entity. More...

virtual void	setCaption (const string &caption)=0
	Sets caption for the entity. More...

virtual string	description () const =0
	Gets additional descriptive information for the entity. More...

virtual void	setDescription (const string &description)=0
	Gets additional descriptive information for the entity. More...

Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=0
	IPropertyChanged::~IPropertyChanged is a virtual destructor. More...

virtual void	registerPropertyChangedListener (const function< void(const any &, const string &)> &propertyChangedListener)=0
	IPropertyChanged::registerPropertyChangedListener() registers a listener to be called when a property of an object changes. More...

virtual void	deRegisterPropertyChangedListener (const function< void(const any &, const string &propertyName)> &propertyChangedListener)=0
	IPropertyChanged::deRegisterPropertyChangedListener() deregisters a listener that is called when a property of an object changes. More...

Detailed Description

An IRasterComponentDataItem represents an IRaster IComponentItem.

Constructor & Destructor Documentation

◆ ~IRasterComponentDataItem()

virtual HydroCouple::Spatial::IRasterComponentDataItem::~IRasterComponentDataItem ( )

pure virtual

IRasterComponentItem destructor.

Member Function Documentation

◆ bandDimension()

virtual IDimension* HydroCouple::Spatial::IRasterComponentDataItem::bandDimension ( ) const

pure virtual

IDimension for IRasterBands.

◆ getValue()

virtual void HydroCouple::Spatial::IRasterComponentDataItem::getValue	(	int	xIndex,
		int	yIndex,
		int	band,
		void *	data
	)		const

pure virtual

getValue for given x dimension index, y dimension index, and band dimension index.

Parameters

xIndex	is the x dimension index from where to obtain the requested data.
yIndex	is the y dimension index from where to obtain the requested data.
band	is the band dimension index from where to obtain the requested data.
data	is a pointer to data that is to be written. Must be allocated beforehand with the correct data type.

◆ getValues()

virtual void HydroCouple::Spatial::IRasterComponentDataItem::getValues	(	int	xIndex,
		int	yIndex,
		int	band,
		int	xStride,
		int	yStride,
		void *	data
	)		const

pure virtual

Gets a multi-dimensional array of values for given dimension for a hyperslab.

Parameters

xIndex	is the x dimension index from where to obtain the requested data.
yIndex	is the y dimension index from where to obtain the requested data.
band	is the band dimension index from where to obtain the requested data.
xStride	is the x size for hyperslab from which to copy data.
yStride	is the x size for hyperslab from which to copy data.
data	is the multi dimensional array where data is to be written. Must be allocated beforehand.

◆ raster()

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

pure virtual

IRaster associated with this IRasterComponentDataItem.

◆ setValue()

virtual void HydroCouple::Spatial::IRasterComponentDataItem::setValue	(	int	xIndex,
		int	yIndex,
		int	band,
		const void *	data
	)

pure virtual

setValue for given x dimension index, y dimension index, and band dimension index.

Parameters

xIndex	is the x dimension index from where to write data.
yIndex	is the y dimension index from where to write data.
band	is the band dimension index from where to write data.
data	is a pointer data thata to is to be copied

◆ setValues()

virtual void HydroCouple::Spatial::IRasterComponentDataItem::setValues	(	int	xIndex,
		int	yIndex,
		int	band,
		int	xStride,
		int	yStride,
		const void *	data
	)

pure virtual

Sets a multi-dimensional array of values for given dimension for a hyperslab.

Parameters

xIndex	is the x dimension index where to set data.
yIndex	is the y dimension index where to set data.
band	is the band dimension index where to set data.
xStride	is the x size for hyperslab where data is to be written.
yStride	is the y size for hyperslab where data is to be written.
data	is the input array to be written.

◆ xDimension()

virtual IDimension* HydroCouple::Spatial::IRasterComponentDataItem::xDimension ( ) const

pure virtual

IDimension for xDirection.

◆ yDimension()

virtual IDimension* HydroCouple::Spatial::IRasterComponentDataItem::yDimension ( ) const

pure virtual

IDimension for yDirection.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IRasterComponentDataItem()

Member Function Documentation

◆ bandDimension()

◆ getValue()

◆ getValues()

◆ raster()

◆ setValue()

◆ setValues()

◆ xDimension()

◆ yDimension()