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

IGeometryComponentItem represents IGeometryCollection IComponentItem. This class must be implemented as an abstract class. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IGeometryComponentDataItem:
Collaboration diagram for HydroCouple::Spatial::IGeometryComponentDataItem:

Public Member Functions

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

IGeometryComponentItem represents IGeometryCollection IComponentItem. This class must be implemented as an abstract class.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual HydroCouple::Spatial::IEnvelope* HydroCouple::Spatial::IGeometryComponentDataItem::envelope ( ) const
pure virtual

envelope

Returns
virtual IGeometry* HydroCouple::Spatial::IGeometryComponentDataItem::geometry ( int  geometryIndex) const
pure virtual

geometry

Parameters
geometryIndex
Returns
virtual int HydroCouple::Spatial::IGeometryComponentDataItem::geometryCount ( ) const
pure virtual

geometryCount

Returns
virtual HydroCouple::IDimension* HydroCouple::Spatial::IGeometryComponentDataItem::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
virtual IGeometry::GeometryType HydroCouple::Spatial::IGeometryComponentDataItem::geometryType ( ) const
pure virtual

geometryType

Returns
virtual void HydroCouple::Spatial::IGeometryComponentDataItem::getValue ( int  geometryDimensionIndex,
void *  data 
) const
pure virtual

Gets value for given geometry dimension index.

Parameters
geometryDimensionIndexis the geometry dimension index from where to obtain the requested data.
datais a pointer to data that is to be written. Must be allocated beforehand with the correct data type.
virtual void HydroCouple::Spatial::IGeometryComponentDataItem::getValues ( int  geometryDimensionIndex,
int  stride,
void *  data 
) const
pure virtual

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

Parameters
geometryDimensionIndexis the geometry dimension index from where to obtain the requested data.
strideis the size 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.
virtual void HydroCouple::Spatial::IGeometryComponentDataItem::setValue ( int  geometryDimensionIndex,
const void *  data 
)
pure virtual

Sets value for given geometry dimension index.

Parameters
geometryDimensionIndexis the geometry dimension index from where to write data.
datais a pointer data thata to is to be copied
virtual void HydroCouple::Spatial::IGeometryComponentDataItem::setValues ( int  geometryDimensionIndex,
int  stride,
const void *  data 
)
pure virtual

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

Parameters
geometryDimensionIndexis the geometry dimension index where data is to be written.
strideis the size for hyperslab where data is to be written.
datais the input multi dimensional array to be written.

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