HydroCouple  1.0.0
Description of the HydroCouple Component-Based Model Coupling Interface Definitions
HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem Class Referenceabstract

The ITimeRasterComponentDataItem class. More...

#include <hydrocouplespatiotemporal.h>

Inheritance diagram for HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem:
Collaboration diagram for HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem:

Public Member Functions

virtual ~ITimeRasterComponentDataItem ()
 
virtual HydroCouple::Spatial::IRasterraster () const =0
 IRaster associated with this IRasterComponentDataItem. More...
 
virtual IDimensionxDimension () const =0
 IDimension for xDirection. More...
 
virtual IDimensionyDimension () const =0
 IDimension for yDirection. More...
 
virtual IDimensionbandDimension () const =0
 IDimension for IRasterBands. More...
 
virtual void getValue (int timeIndex, int xIndex, int yIndex, int band, void *data) const =0
 getValue More...
 
virtual void getValues (int timeIndex, int xindex, int yindex, int bandIndex, int timeStride, int xstride, int ystride, int bandStride, void *data) const =0
 Gets a multi-dimensional array of values for given dimension for a hyperslab. More...
 
virtual void setValue (int timeIndex, int xIndex, int yIndex, int band, const void *data)=0
 setValue More...
 
virtual void setValues (int timeIndex, int xindex, int yindex, int bandIndex, int timeStride, int xstride, int ystride, int bandStride, const void *data)=0
 Sets a multi-dimensional array of values for given dimension for a hyperslab. More...
 
- Public Member Functions inherited from HydroCouple::Temporal::ITimeComponentDataItem
virtual ~ITimeComponentDataItem ()
 ~ITimeComponentItem. More...
 
virtual QList< IDateTime * > times () const =0
 ITimes associated with this dimension. More...
 
virtual IDateTimetime (int timeIndex) const =0
 time More...
 
virtual int timeCount () const =0
 timeCount More...
 
virtual ITimeSpantimeSpan () const =0
 ITimeSpan associated with this dimension. More...
 
virtual IDimensiontimeDimension () const =0
 IDimension of the times. More...
 
- Public Member Functions inherited from HydroCouple::IComponentDataItem
virtual ~IComponentDataItem ()
 
virtual IModelComponentmodelComponent () 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 QList< IDimension * > dimensions () const =0
 provides purely descriptive information of the dimensions associated with this IComponentItem More...
 
virtual int dimensionLength (const std::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 IValueDefinitionvalueDefinition () const =0
 IValueDefinition for this IValueSet defines the variable type associated with this object. More...
 
virtual void getValue (const std::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 std::vector< int > &dimensionIndexes, const void *data)=0
 Sets a multi-dimensional array of values for given dimension indexes. More...
 
- 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

Constructor & Destructor Documentation

virtual HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem::~ITimeRasterComponentDataItem ( )
inlinevirtual

Here is the call graph for this function:

Member Function Documentation

virtual IDimension* HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem::bandDimension ( ) const
pure virtual

IDimension for IRasterBands.

virtual void HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem::getValue ( int  timeIndex,
int  xIndex,
int  yIndex,
int  band,
void *  data 
) const
pure virtual

getValue

Parameters
timeIndex
xIndex
yIndex
band
data
virtual void HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem::getValues ( int  timeIndex,
int  xindex,
int  yindex,
int  bandIndex,
int  timeStride,
int  xstride,
int  ystride,
int  bandStride,
void *  data 
) const
pure virtual

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

Parameters
timeIndexis the time dimension index from where to obtain the requested data.
xindexis the x dimension index from where to obtain the requested data.
yindexis the y dimension index from where to obtain the requested data.
bandIndexis the band dimension index from where to obtain the requested data.
timeStrideis the size for the time dimension for hyperslab from which to copy data.
xstrideis the x size for hyperslab from which to copy data.
ystrideis the x size for hyperslab from which to copy data.
bandStrideis the band size for hyperslab from which to copy data.
datais the multi dimensional array where data is to be written. Must be allocated beforehand.
virtual HydroCouple::Spatial::IRaster* HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem::raster ( ) const
pure virtual

IRaster associated with this IRasterComponentDataItem.

virtual void HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem::setValue ( int  timeIndex,
int  xIndex,
int  yIndex,
int  band,
const void *  data 
)
pure virtual

setValue

Parameters
timeIndex
xIndex
yIndex
band
data
virtual void HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem::setValues ( int  timeIndex,
int  xindex,
int  yindex,
int  bandIndex,
int  timeStride,
int  xstride,
int  ystride,
int  bandStride,
const void *  data 
)
pure virtual

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

Parameters
timeIndexis the time dimension index where data is to be written.
xindexis the x dimension index where to set data.
yindexis the y dimension index where to set data.
bandIndexis the band dimension index from where to obtain the requested data.
timeStrideis the size for the time dimension for hyperslab from which to copy data.
xstrideis the x size for hyperslab from which to copy data.
ystrideis the x size for hyperslab from which to copy data.
bandStrideis the band size for hyperslab from which to copy data.
datais the input array to be written.
virtual IDimension* HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem::xDimension ( ) const
pure virtual

IDimension for xDirection.

virtual IDimension* HydroCouple::SpatioTemporal::ITimeRasterComponentDataItem::yDimension ( ) const
pure virtual

IDimension for yDirection.


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