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

The ITimePolyhedralSurfaceComponentItem class. More...

#include <hydrocouplespatiotemporal.h>

Inheritance diagram for HydroCouple::SpatioTemporal::ITimePolyhedralSurfaceComponentDataItem:
Collaboration diagram for HydroCouple::SpatioTemporal::ITimePolyhedralSurfaceComponentDataItem:

Public Member Functions

virtual ~ITimePolyhedralSurfaceComponentDataItem ()
 ~ITimePolyhedralSurfaceComponentItem. More...
 
virtual HydroCouple::Spatial::MeshDataType meshDataType () const =0
 polyhedralSurfaceDataType More...
 
virtual HydroCouple::Spatial::IPolyhedralSurfacepolyhedralSurface () const =0
 
virtual IDimensioncellDimension () const =0
 
virtual IDimensionedgeDimension () const =0
 edgeDimension More...
 
virtual IDimensionnodeDimension () const =0
 nodeDimension More...
 
virtual void getValue (int timeIndex, int cellDimensionIndex, int edgeDimensionIndex, int nodeDimensionIndex, void *data) const =0
 getValue More...
 
virtual void setValue (int timeIndex, int cellDimensionIndex, int edgeDimensionIndex, int nodeDimensionIndex, const void *data)=0
 setValues More...
 
- 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...
 
- 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 ITimePolyhedralSurfaceComponentItem class.

Constructor & Destructor Documentation

virtual HydroCouple::SpatioTemporal::ITimePolyhedralSurfaceComponentDataItem::~ITimePolyhedralSurfaceComponentDataItem ( )
inlinevirtual

~ITimePolyhedralSurfaceComponentItem.

Here is the call graph for this function:

Member Function Documentation

virtual IDimension* HydroCouple::SpatioTemporal::ITimePolyhedralSurfaceComponentDataItem::cellDimension ( ) const
pure virtual
Returns
TcellDimension.
virtual IDimension* HydroCouple::SpatioTemporal::ITimePolyhedralSurfaceComponentDataItem::edgeDimension ( ) const
pure virtual

edgeDimension

Returns
virtual void HydroCouple::SpatioTemporal::ITimePolyhedralSurfaceComponentDataItem::getValue ( int  timeIndex,
int  cellDimensionIndex,
int  edgeDimensionIndex,
int  nodeDimensionIndex,
void *  data 
) const
pure virtual

getValue

Parameters
timeIndex
cellDimensionIndex
edgeDimensionIndex
nodeDimensionIndex
data
virtual HydroCouple::Spatial::MeshDataType HydroCouple::SpatioTemporal::ITimePolyhedralSurfaceComponentDataItem::meshDataType ( ) const
pure virtual

polyhedralSurfaceDataType

Returns
virtual IDimension* HydroCouple::SpatioTemporal::ITimePolyhedralSurfaceComponentDataItem::nodeDimension ( ) const
pure virtual

nodeDimension

Returns
virtual HydroCouple::Spatial::IPolyhedralSurface* HydroCouple::SpatioTemporal::ITimePolyhedralSurfaceComponentDataItem::polyhedralSurface ( ) const
pure virtual
Returns
The IPolyhedralSurface associated with this IPolyhedralSurfaceDimension.
virtual void HydroCouple::SpatioTemporal::ITimePolyhedralSurfaceComponentDataItem::setValue ( int  timeIndex,
int  cellDimensionIndex,
int  edgeDimensionIndex,
int  nodeDimensionIndex,
const void *  data 
)
pure virtual

setValues

Parameters
timeIndex
cellDimensionIndex
edgeDimensionIndex
nodeDimensionIndex
data

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