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

An IRegularGrid2DComponentDataItem represents an IRegularGrid2D IComponentItem. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IRegularGrid2DComponentDataItem:
Collaboration diagram for HydroCouple::Spatial::IRegularGrid2DComponentDataItem:

Public Member Functions

virtual ~IRegularGrid2DComponentDataItem ()
 ~IRegularGrid2DComponentItem. More...
 
virtual IRegularGrid2Dgrid () const =0
 IRegularGrid2D grid associated with this IRegularGrid2DComponentItem. More...
 
virtual MeshDataType meshDataType () const =0
 meshDataType More...
 
virtual IDimensionxCellDimension () const =0
 Number of X cells IDimension. More...
 
virtual IDimensionyCellDimension () const =0
 Number of Y cells IDimension. More...
 
virtual IDimensioncellEdgeDimension () const =0
 cellEdgeDimension. Edge indices start from the bottom and go in a counter clockwise order. More...
 
virtual IDimensioncellNodeDimension () const =0
 cellNodeDimension. Node indices start from the bottom left and go in a counter clockwise order. More...
 
virtual void getValue (int xCellIndex, int yCellIndex, int cellEdgeIndex, int cellNodeIndex, void *data) const =0
 getValue More...
 
virtual void setValue (int xCellIndex, int yCellIndex, int cellEdgeIndex, int cellNodeIndex, const void *data)=0
 setValue 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

An IRegularGrid2DComponentDataItem represents an IRegularGrid2D IComponentItem.

Constructor & Destructor Documentation

virtual HydroCouple::Spatial::IRegularGrid2DComponentDataItem::~IRegularGrid2DComponentDataItem ( )
inlinevirtual

~IRegularGrid2DComponentItem.

Member Function Documentation

virtual IDimension* HydroCouple::Spatial::IRegularGrid2DComponentDataItem::cellEdgeDimension ( ) const
pure virtual

cellEdgeDimension. Edge indices start from the bottom and go in a counter clockwise order.

Returns
virtual IDimension* HydroCouple::Spatial::IRegularGrid2DComponentDataItem::cellNodeDimension ( ) const
pure virtual

cellNodeDimension. Node indices start from the bottom left and go in a counter clockwise order.

Returns
virtual void HydroCouple::Spatial::IRegularGrid2DComponentDataItem::getValue ( int  xCellIndex,
int  yCellIndex,
int  cellEdgeIndex,
int  cellNodeIndex,
void *  data 
) const
pure virtual

getValue

Parameters
xCellIndex
yCellIndex
cellEdgeIndex
cellNodeIndex
data
virtual IRegularGrid2D* HydroCouple::Spatial::IRegularGrid2DComponentDataItem::grid ( ) const
pure virtual

IRegularGrid2D grid associated with this IRegularGrid2DComponentItem.

virtual MeshDataType HydroCouple::Spatial::IRegularGrid2DComponentDataItem::meshDataType ( ) const
pure virtual

meshDataType

Returns
virtual void HydroCouple::Spatial::IRegularGrid2DComponentDataItem::setValue ( int  xCellIndex,
int  yCellIndex,
int  cellEdgeIndex,
int  cellNodeIndex,
const void *  data 
)
pure virtual

setValue

Parameters
xCellIndex
yCellIndex
cellEdgeIndex
cellNodeIndex
data
virtual IDimension* HydroCouple::Spatial::IRegularGrid2DComponentDataItem::xCellDimension ( ) const
pure virtual

Number of X cells IDimension.

virtual IDimension* HydroCouple::Spatial::IRegularGrid2DComponentDataItem::yCellDimension ( ) const
pure virtual

Number of Y cells IDimension.


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