HydroCouple  2.0.0
HydroCouple Interface Definitions
HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem Class Referenceabstract

The ITimeRegularGrid2DComponentItem class. More...

#include <hydrocouplespatiotemporal.h>

Inheritance diagram for HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem:
Collaboration diagram for HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem:

Public Member Functions

virtual ~ITimeRegularGrid2DComponentDataItem ()=0
 ~ITimeRegularGrid2DComponentItem. Destructor. More...
 
virtual HydroCouple::Spatial::IRegularGrid2Dgrid () const =0
 IRegularGrid2D grid associated with this IRegularGrid2DComponentItem. More...
 
virtual HydroCouple::Spatial::MeshDataType meshDataType () const =0
 meshDataType The mesh data type for the regular grid. 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 timeIndex, int xCellIndex, int yCellIndex, int cellEdgeIndex, int cellNodeIndex, void *data) const =0
 getValue Gets the value for given time dimension index, x cell dimension index, y cell dimension index, cell edge dimension index and cell node dimension index. More...
 
virtual void setValue (int timeIndex, int xCellIndex, int yCellIndex, int cellEdgeIndex, int cellNodeIndex, const void *data)=0
 setValue Sets the value for given time dimension index, x cell dimension index, y cell dimension index, cell edge dimension index and cell node dimension index. More...
 
- Public Member Functions inherited from HydroCouple::Temporal::ITimeComponentDataItem
virtual ~ITimeComponentDataItem ()=0
 ~ITimeComponentItem destructor. More...
 
virtual list< 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 ()=0
 IComponentDataItem::~IComponentDataItem is a virtual destructor. More...
 
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 vector< IDimension * > dimensions () const =0
 provides purely descriptive information of the dimensions associated with this IComponentItem More...
 
virtual int dimensionLength (const 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 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 vector< int > &dimensionIndexes, const void *data)=0
 Sets a multi-dimensional array of values for given dimension indexes. More...
 
virtual bool hasEditor () const =0
 hasEditor indicates whether this IComponentItem has a UI editor. More...
 
virtual void showEditor ()=0
 showEditor shows the editor for this IComponentItem. More...
 
virtual bool hasViewer () const =0
 hasViewer indicates whether this IComponentItem has a UI viewer. More...
 
virtual void showViewer ()=0
 showViewer More...
 
- Public Member Functions inherited from HydroCouple::IIdentity
virtual ~IIdentity ()=0
 IIdentity::~IIdentity is a virtual destructor. More...
 
virtual string id () const =0
 Gets a unique identifier for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IDescription
virtual ~IDescription ()=0
 IDescription::~IDescription is a virtual destructor. More...
 
virtual string caption () const =0
 Gets caption for the entity. More...
 
virtual void setCaption (const string &caption)=0
 Sets caption for the entity. More...
 
virtual string description () const =0
 Gets additional descriptive information for the entity. More...
 
virtual void setDescription (const string &description)=0
 Gets additional descriptive information for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual ~IPropertyChanged ()=0
 IPropertyChanged::~IPropertyChanged is a virtual destructor. More...
 
virtual void registerPropertyChangedListener (const function< void(const any &, const string &)> &propertyChangedListener)=0
 IPropertyChanged::registerPropertyChangedListener() registers a listener to be called when a property of an object changes. More...
 
virtual void deRegisterPropertyChangedListener (const function< void(const any &, const string &propertyName)> &propertyChangedListener)=0
 IPropertyChanged::deRegisterPropertyChangedListener() deregisters a listener that is called when a property of an object changes. More...
 

Detailed Description

The ITimeRegularGrid2DComponentItem class.

Constructor & Destructor Documentation

◆ ~ITimeRegularGrid2DComponentDataItem()

virtual HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem::~ITimeRegularGrid2DComponentDataItem ( )
pure virtual

~ITimeRegularGrid2DComponentItem. Destructor.

Member Function Documentation

◆ cellEdgeDimension()

virtual IDimension* HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem::cellEdgeDimension ( ) const
pure virtual

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

Returns

◆ cellNodeDimension()

virtual IDimension* HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem::cellNodeDimension ( ) const
pure virtual

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

Returns

◆ getValue()

virtual void HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem::getValue ( int  timeIndex,
int  xCellIndex,
int  yCellIndex,
int  cellEdgeIndex,
int  cellNodeIndex,
void *  data 
) const
pure virtual

getValue Gets the value for given time dimension index, x cell dimension index, y cell dimension index, cell edge dimension index and cell node dimension index.

Parameters
timeIndexis the time dimension index from where to obtain the requested data.
xCellIndexis the x cell dimension index from where to obtain the requested data.
yCellIndexis the y cell dimension index from where to obtain the requested data.
cellEdgeIndexis the cell edge dimension index from where to obtain the requested data.
cellNodeIndexis the cell node dimension index from where to obtain the requested data.
datais the array where data is to be written. Must be allocated beforehand with the correct data type.

◆ grid()

virtual HydroCouple::Spatial::IRegularGrid2D* HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem::grid ( ) const
pure virtual

IRegularGrid2D grid associated with this IRegularGrid2DComponentItem.

◆ meshDataType()

virtual HydroCouple::Spatial::MeshDataType HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem::meshDataType ( ) const
pure virtual

meshDataType The mesh data type for the regular grid.

Returns
The mesh data type for the regular grid.

◆ setValue()

virtual void HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem::setValue ( int  timeIndex,
int  xCellIndex,
int  yCellIndex,
int  cellEdgeIndex,
int  cellNodeIndex,
const void *  data 
)
pure virtual

setValue Sets the value for given time dimension index, x cell dimension index, y cell dimension index, cell edge dimension index and cell node dimension index.

Parameters
timeIndexis the time dimension index where data is to be written.
xCellIndexis the x cell dimension index where data is to be written.
yCellIndexis the y cell dimension index where data is to be written.
cellEdgeIndexis the cell edge dimension index where data is to be written.
cellNodeIndexis the cell node dimension index where data is to be written.
datais the input array to be written.

◆ xCellDimension()

virtual IDimension* HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem::xCellDimension ( ) const
pure virtual

Number of X cells IDimension.

◆ yCellDimension()

virtual IDimension* HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem::yCellDimension ( ) const
pure virtual

Number of Y cells IDimension.


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