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

ITimeGeometryComponentItem represents an IComponentItem with both temporal and geometric components. More...

#include <hydrocouplespatiotemporal.h>

Inheritance diagram for HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem:
Collaboration diagram for HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem:

Public Member Functions

virtual ~ITimeGeometryComponentDataItem ()
 ~ITimeGeometryComponentItem. More...
 
virtual HydroCouple::Spatial::IGeometry::GeometryType geometryType () const =0
 geometryType More...
 
virtual int geometryCount () const =0
 geometryCount More...
 
virtual HydroCouple::Spatial::IGeometrygeometry (int geometryIndex) const =0
 geometry More...
 
virtual HydroCouple::IDimensiongeometryDimension () const =0
 
virtual HydroCouple::Spatial::IEnvelopeenvelope () const =0
 envelope More...
 
virtual void getValue (int timeIndex, int geometryIndex, void *data) const =0
 getValue More...
 
virtual void getValues (int timeIndex, int geometryIndex, int timeStride, int geomStride, void *data) const =0
 Gets a multi-dimensional array of values for given time dimension index and size for a hyperslab. More...
 
virtual void setValue (int timeIndex, int geometryIndex, const void *data)=0
 setValues More...
 
virtual void setValues (int timeIndex, int geometryIndex, int timeStride, int geomStride, const void *data)=0
 Sets a multi-dimensional array of values for given time dimension index and size for a hyperslab. 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

ITimeGeometryComponentItem represents an IComponentItem with both temporal and geometric components.

Constructor & Destructor Documentation

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

~ITimeGeometryComponentItem.

Here is the call graph for this function:

Member Function Documentation

virtual HydroCouple::Spatial::IEnvelope* HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem::envelope ( ) const
pure virtual

envelope

Returns

Here is the caller graph for this function:

virtual HydroCouple::Spatial::IGeometry* HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem::geometry ( int  geometryIndex) const
pure virtual

geometry

Parameters
geometryIndex
Returns

Here is the caller graph for this function:

virtual int HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem::geometryCount ( ) const
pure virtual

geometryCount

Returns

Here is the caller graph for this function:

virtual HydroCouple::IDimension* HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem::geometryDimension ( ) const
pure virtual
Returns
The dimesion attributes for the data with the geometry. This can be the field name for an attribute for a shapefile. Must be the first dimension in the dimensions() list

Here is the caller graph for this function:

virtual HydroCouple::Spatial::IGeometry::GeometryType HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem::geometryType ( ) const
pure virtual

geometryType

Returns

Here is the caller graph for this function:

virtual void HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem::getValue ( int  timeIndex,
int  geometryIndex,
void *  data 
) const
pure virtual

getValue

Parameters
timeIndex
geometryIndex
data

Here is the caller graph for this function:

virtual void HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem::getValues ( int  timeIndex,
int  geometryIndex,
int  timeStride,
int  geomStride,
void *  data 
) const
pure virtual

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

Parameters
timeIndexis the time dimension index from where to obtain the requested data.
geometryIndexis the geometry dimension index from where to obtain the requested data.
timeStrideis the size for the time dimension for hyperslab from which to copy data.
geomStrideis the size for the geometry dimension for hyperslab from which to copy data.
datais a multi dimensional array where data is to be written. Must be allocated beforehand with the correct data type.

Here is the caller graph for this function:

virtual void HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem::setValue ( int  timeIndex,
int  geometryIndex,
const void *  data 
)
pure virtual

setValues

Parameters
timeIndex
geometryIndex
data

Here is the caller graph for this function:

virtual void HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem::setValues ( int  timeIndex,
int  geometryIndex,
int  timeStride,
int  geomStride,
const void *  data 
)
pure virtual

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

Parameters
timeIndexis the time dimension index from where to obtain the requested data.
geometryIndexis the geometry dimension index from where to obtain the requested data.
timeStrideis the size for the time dimension for hyperslab from which to copy data.
geomStrideis the size for the geometry dimension for hyperslab from which to copy data.
datais the input multi dimensional array to be written.

Here is the caller graph for this function:


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