HydroCouple  1.0.0
Description of the HydroCouple Component-Based Model Coupling Interface Definitions
HydroCouple::Temporal::ITimeIdBasedComponentDataItem Class Referenceabstract

The ITimeIdBasedComponentDataItem class. More...

#include <hydrocoupletemporal.h>

Inheritance diagram for HydroCouple::Temporal::ITimeIdBasedComponentDataItem:
Collaboration diagram for HydroCouple::Temporal::ITimeIdBasedComponentDataItem:

Public Member Functions

virtual ~ITimeIdBasedComponentDataItem ()
 
virtual QStringList identifiers () const =0
 identifiers More...
 
virtual IDimensionidentifierDimension () const =0
 idDimensions More...
 
virtual void getValue (int timeIndex, int idIndex, void *data) const =0
 Gets a single value for given id dimension index. More...
 
virtual void getValues (int timeIndex, int idIndex, int timeStride, int idStride, void *data) const =0
 Gets a multi-dimensional array of values for given id dimension index and size for a hyperslab. More...
 
virtual void setValue (int timeIndex, int idIndex, const void *data)=0
 Sets a single value for given id dimension index. More...
 
virtual void setValues (int timeIndex, int idIndex, int timeStride, int idStride, const void *data)=0
 Sets a multi-dimensional array of values for given id dimension index and size for a hyperslab. 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 ()
 
- 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...
 

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::Temporal::ITimeIdBasedComponentDataItem::~ITimeIdBasedComponentDataItem ( )
inlinevirtual

Member Function Documentation

virtual void HydroCouple::Temporal::ITimeIdBasedComponentDataItem::getValue ( int  timeIndex,
int  idIndex,
void *  data 
) const
pure virtual

Gets a single value for given id dimension index.

Parameters
timeIndexis the time dimension index from where to obtain the requested data.
idIndexis the id dimension index from where to obtain the requested data.
datais a pre-allocated pointer to the location data is to be written.
virtual void HydroCouple::Temporal::ITimeIdBasedComponentDataItem::getValues ( int  timeIndex,
int  idIndex,
int  timeStride,
int  idStride,
void *  data 
) const
pure virtual

Gets a multi-dimensional array of values for given id dimension index and size for a hyperslab.

Parameters
timeIndexis the time dimension index from where to obtain the requested data.
idIndexis the id dimension index from where to obtain the requested data.
timeStrideis the size for hyperslab from which to copy data.
idStrideis the size for hyperslab from which to copy data.
datais a 1d array where data is to be written. Must be allocated beforehand with the correct data type.
virtual IDimension* HydroCouple::Temporal::ITimeIdBasedComponentDataItem::identifierDimension ( ) const
pure virtual

idDimensions

Returns
virtual QStringList HydroCouple::Temporal::ITimeIdBasedComponentDataItem::identifiers ( ) const
pure virtual

identifiers

Returns
virtual void HydroCouple::Temporal::ITimeIdBasedComponentDataItem::setValue ( int  timeIndex,
int  idIndex,
const void *  data 
)
pure virtual

Sets a single value for given id dimension index.

Parameters
timeIndexis the time dimension index from where to obtain the requested data.
idIndexis the id dimension index where data is to be written.
datais the pointer to a pre-allocated location where data to be written.
virtual void HydroCouple::Temporal::ITimeIdBasedComponentDataItem::setValues ( int  timeIndex,
int  idIndex,
int  timeStride,
int  idStride,
const void *  data 
)
pure virtual

Sets a multi-dimensional array of values for given id dimension index and size for a hyperslab.

Parameters
timeIndexis the time dimension index from where to obtain the requested data.
idIndexis the id dimension index where data is to be written.
timeStrideis the size for hyperslab where data is to be written.
idStrideis the size for hyperslab where data is to be written.
datais the input 1d array to be written.

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