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

The IVectorComponentDataItem class. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IVectorComponentDataItem:
Collaboration diagram for HydroCouple::Spatial::IVectorComponentDataItem:

Public Member Functions

virtual ~IVectorComponentDataItem ()
 ~IVectorComponentDataItem More...
 
virtual int locationsCount () const =0
 locationCount More...
 
virtual IPointlocation (int locationIndex) const =0
 location More...
 
virtual IDimensionlocationsDimension () const =0
 locationsDimension More...
 
virtual IDimensionspatialDimension () const =0
 dataTypeDimension alway has a length of 3. 0 = x-direction value, 1 = y-direction, 2 = z-direction, More...
 
virtual void getValue (int locationIndex, int spatialDimensionIndex, void *data) const =0
 getValue More...
 
virtual void getValues (int locationIndex, int spatialDimensionIndex, int locationStride, int spatialDimensionStride, void *data) const =0
 getValues More...
 
virtual void setValue (int locationIndex, int spatialDimensionIndex, const void *data)=0
 setValue More...
 
virtual void setValues (int locationIndex, int spatialDimensionIndex, int locationStride, int spatialDimensionStride, const void *data)=0
 setValues 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::Spatial::IVectorComponentDataItem::~IVectorComponentDataItem ( )
inlinevirtual

~IVectorComponentDataItem

Member Function Documentation

virtual void HydroCouple::Spatial::IVectorComponentDataItem::getValue ( int  locationIndex,
int  spatialDimensionIndex,
void *  data 
) const
pure virtual

getValue

Parameters
locationIndex
spatialDimensionIndex
data
virtual void HydroCouple::Spatial::IVectorComponentDataItem::getValues ( int  locationIndex,
int  spatialDimensionIndex,
int  locationStride,
int  spatialDimensionStride,
void *  data 
) const
pure virtual

getValues

Parameters
locationIndex
spatialDimensionIndex
locationStride
spatialDimensionStride
data
virtual IPoint* HydroCouple::Spatial::IVectorComponentDataItem::location ( int  locationIndex) const
pure virtual

location

Parameters
locationIndex
Returns
virtual int HydroCouple::Spatial::IVectorComponentDataItem::locationsCount ( ) const
pure virtual

locationCount

Returns
virtual IDimension* HydroCouple::Spatial::IVectorComponentDataItem::locationsDimension ( ) const
pure virtual

locationsDimension

Returns
virtual void HydroCouple::Spatial::IVectorComponentDataItem::setValue ( int  locationIndex,
int  spatialDimensionIndex,
const void *  data 
)
pure virtual

setValue

Parameters
locationIndex
spatialDimensionIndex
data
virtual void HydroCouple::Spatial::IVectorComponentDataItem::setValues ( int  locationIndex,
int  spatialDimensionIndex,
int  locationStride,
int  spatialDimensionStride,
const void *  data 
)
pure virtual

setValues

Parameters
locationIndex
spatialDimensionIndex
locationStride
spatialDimensionStride
data
virtual IDimension* HydroCouple::Spatial::IVectorComponentDataItem::spatialDimension ( ) const
pure virtual

dataTypeDimension alway has a length of 3. 0 = x-direction value, 1 = y-direction, 2 = z-direction,

Returns

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