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

The IIdBasedComponentItem class is an idbased IComponentItem. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IIdBasedComponentDataItem:
Collaboration diagram for HydroCouple::IIdBasedComponentDataItem:

Public Member Functions

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

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

The IIdBasedComponentItem class is an idbased IComponentItem.

Constructor & Destructor Documentation

virtual HydroCouple::IIdBasedComponentDataItem::~IIdBasedComponentDataItem ( )
inlinevirtual

~IIdBasedComponentItem.

Member Function Documentation

virtual void HydroCouple::IIdBasedComponentDataItem::getValue ( int  idIndex,
void *  data 
) const
pure virtual

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

Parameters
idIndexis the id dimension index from where to obtain the requested data.
datais pre-allocated memory where the data will be written.
virtual void HydroCouple::IIdBasedComponentDataItem::getValues ( int  idIndex,
int  stride,
void *  data 
) const
pure virtual

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

Parameters
idIndexis the id dimension index from where to obtain the requested data.
strideis 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::IIdBasedComponentDataItem::identifierDimension ( ) const
pure virtual

idDimensions

Returns
virtual QStringList HydroCouple::IIdBasedComponentDataItem::identifiers ( ) const
pure virtual

identifiers

Returns
virtual void HydroCouple::IIdBasedComponentDataItem::setValue ( int  idIndex,
const void *  data 
)
pure virtual

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

Parameters
idIndexis the id dimension index where data is to be written.
datais the pre-allocated location where data is to be set.
virtual void HydroCouple::IIdBasedComponentDataItem::setValues ( int  idIndex,
int  stride,
const void *  data 
)
pure virtual

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

Parameters
idIndexis the id dimension index where data is to be written.
strideis 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: