HydroCouple  2.0.0
HydroCouple 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 ()=0
 ~ITimeGeometryComponentItem. More...
 
virtual HydroCouple::Spatial::IGeometry::GeometryType geometryType () const =0
 geometryType More...
 
virtual int geometryCount () const =0
 geometryCount The number of geometries in the data item. More...
 
virtual HydroCouple::Spatial::IGeometrygeometry (int geometryIndex) const =0
 geometry The geometry at the specified index. More...
 
virtual HydroCouple::IDimensiongeometryDimension () const =0
 
virtual HydroCouple::Spatial::IEnvelopeenvelope () const =0
 envelope The envelope of the data item. More...
 
virtual void getValue (int timeIndex, int geometryIndex, void *data) const =0
 getValue Gets the value for given time dimension index and geometry dimension index. 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 Sets the value for given time dimension index and geometry dimension index. 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 ()=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

ITimeGeometryComponentItem represents an IComponentItem with both temporal and geometric components.

Constructor & Destructor Documentation

◆ ~ITimeGeometryComponentDataItem()

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

~ITimeGeometryComponentItem.

Member Function Documentation

◆ envelope()

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

envelope The envelope of the data item.

Returns
The envelope of the data item.

◆ geometry()

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

geometry The geometry at the specified index.

Parameters
geometryIndexThe index of the geometry to return.
Returns
The geometry at the specified index.

◆ geometryCount()

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

geometryCount The number of geometries in the data item.

Returns
The number of geometries in the data item.

◆ geometryDimension()

virtual HydroCouple::IDimension* HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem::geometryDimension ( ) const
pure virtual
Returns
The dimension 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

◆ geometryType()

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

geometryType

Returns

◆ getValue()

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

getValue Gets the value for given time dimension index and geometry dimension index.

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.
datais the array where data is to be written. Must be allocated beforehand with the correct data type.

◆ getValues()

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.

◆ setValue()

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

setValues Sets the value for given time dimension index and geometry dimension index.

Parameters
timeIndexis the time dimension index where data is to be written.
geometryIndexis the geometry dimension index where data is to be written.
datais the input array to be written.

◆ setValues()

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.

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