HydroCouple  1.0.0
Description of the HydroCouple Component-Based Model Coupling Interface Definitions
HydroCouple::Temporal::ITimeComponentDataItem Class Referenceabstract

ITimeComponentItem is an IComponentItem with a temporal attribute. This class cannot be directly instantiated and must be implemented as an abstract class that can be inherited by its specializations e.g., ITimeSeriesComponentDataItem, ITimeSeriesArgument, ITimeIdBasedComponentDataItem, ITimeIdBasedExchangeItem, ITimeIdBasedArgument, or other geotemporal datasets. More...

#include <hydrocoupletemporal.h>

Inheritance diagram for HydroCouple::Temporal::ITimeComponentDataItem:
Collaboration diagram for HydroCouple::Temporal::ITimeComponentDataItem:

Public Member Functions

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

ITimeComponentItem is an IComponentItem with a temporal attribute. This class cannot be directly instantiated and must be implemented as an abstract class that can be inherited by its specializations e.g., ITimeSeriesComponentDataItem, ITimeSeriesArgument, ITimeIdBasedComponentDataItem, ITimeIdBasedExchangeItem, ITimeIdBasedArgument, or other geotemporal datasets.

Constructor & Destructor Documentation

virtual HydroCouple::Temporal::ITimeComponentDataItem::~ITimeComponentDataItem ( )
inlinevirtual

~ITimeComponentItem.

Member Function Documentation

virtual IDateTime* HydroCouple::Temporal::ITimeComponentDataItem::time ( int  timeIndex) const
pure virtual

time

Parameters
timeIndex
Returns
virtual int HydroCouple::Temporal::ITimeComponentDataItem::timeCount ( ) const
pure virtual

timeCount

Returns
virtual IDimension* HydroCouple::Temporal::ITimeComponentDataItem::timeDimension ( ) const
pure virtual

IDimension of the times.

Returns
IDimension
virtual QList<IDateTime*> HydroCouple::Temporal::ITimeComponentDataItem::times ( ) const
pure virtual

ITimes associated with this dimension.

Returns
QList<IDateTime*>
virtual ITimeSpan* HydroCouple::Temporal::ITimeComponentDataItem::timeSpan ( ) const
pure virtual

ITimeSpan associated with this dimension.


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