HydroCouple::Temporal::ITimeComponentDataItem Class Reference

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 ()=0
	~ITimeComponentItem destructor. More...
virtual list< IDateTime * >	times () const =0
	ITimes associated with this dimension. More...
virtual IDateTime *	time (int timeIndex) const =0
	time More...
virtual int	timeCount () const =0
	timeCount More...
virtual ITimeSpan *	timeSpan () const =0
	ITimeSpan associated with this dimension. More...
virtual IDimension *	timeDimension () 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 IModelComponent *	modelComponent () 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 IValueDefinition *	valueDefinition () 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

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

~ITimeComponentDataItem()

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

pure virtual

~ITimeComponentItem destructor.

Member Function Documentation

time()

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

pure virtual

time

Parameters

timeIndex

Returns

timeCount()

virtual int HydroCouple::Temporal::ITimeComponentDataItem::timeCount ( ) const

pure virtual

timeCount

Returns

timeDimension()

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

pure virtual

IDimension of the times.

Returns

IDimension

times()

virtual list<IDateTime *> HydroCouple::Temporal::ITimeComponentDataItem::times ( ) const

pure virtual

ITimes associated with this dimension.

Returns

QList<IDateTime*>

timeSpan()

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:

• /home/runner/work/HydroCouple/HydroCouple/HydroCouple/include/hydrocoupletemporal.h