The ITimeIdBasedComponentDataItem class. More...

#include <hydrocoupletemporal.h>

Inheritance diagram for HydroCouple::Temporal::ITimeIdBasedComponentDataItem:

Collaboration diagram for HydroCouple::Temporal::ITimeIdBasedComponentDataItem:

Public Member Functions
virtual	~ITimeIdBasedComponentDataItem ()=0
	~ITimeIdBasedComponentDataItem destructor. More...

virtual list< string >	identifiers () const =0
	identifiers associated with this dimension. More...

virtual IDimension *	identifierDimension () const =0
	idDimensions associated with this dimension. More...

virtual void	getValue (int timeIndex, int idIndex, void *data) const =0
	Gets a single value for given id dimension index. More...

virtual void	getValues (int timeIndex, int idIndex, int timeStride, int idStride, void *data) const =0
	Gets a multi-dimensional array of values for given id dimension index and size for a hyperslab. More...

virtual void	setValue (int timeIndex, int idIndex, const void *data)=0
	Sets a single value for given id dimension index. More...

virtual void	setValues (int timeIndex, int idIndex, int timeStride, int idStride, const void *data)=0
	Sets a multi-dimensional array of values for given id dimension index and size for a hyperslab. 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...

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 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...

Detailed Description

The ITimeIdBasedComponentDataItem class.

Constructor & Destructor Documentation

◆ ~ITimeIdBasedComponentDataItem()

virtual HydroCouple::Temporal::ITimeIdBasedComponentDataItem::~ITimeIdBasedComponentDataItem ( )

pure virtual

~ITimeIdBasedComponentDataItem destructor.

Member Function Documentation

◆ getValue()

virtual void HydroCouple::Temporal::ITimeIdBasedComponentDataItem::getValue	(	int	timeIndex,
		int	idIndex,
		void *	data
	)		const

pure virtual

Gets a single value for given id dimension index.

Parameters

timeIndex	is the time dimension index from where to obtain the requested data.
idIndex	is the id dimension index from where to obtain the requested data.
data	is a pre-allocated pointer to the location data is to be written.

◆ getValues()

virtual void HydroCouple::Temporal::ITimeIdBasedComponentDataItem::getValues	(	int	timeIndex,
		int	idIndex,
		int	timeStride,
		int	idStride,
		void *	data
	)		const

pure virtual

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

Parameters

timeIndex	is the time dimension index from where to obtain the requested data.
idIndex	is the id dimension index from where to obtain the requested data.
timeStride	is the size for hyperslab from which to copy data.
idStride	is the size for hyperslab from which to copy data.
data	is a 1d array where data is to be written. Must be allocated beforehand with the correct data type.

◆ identifierDimension()

virtual IDimension* HydroCouple::Temporal::ITimeIdBasedComponentDataItem::identifierDimension ( ) const

pure virtual

idDimensions associated with this dimension.

Returns: IDimension of the identifiers associated with this dimension.

◆ identifiers()

virtual list<string> HydroCouple::Temporal::ITimeIdBasedComponentDataItem::identifiers ( ) const

pure virtual

identifiers associated with this dimension.

Returns: list<string> of identifiers

◆ setValue()

virtual void HydroCouple::Temporal::ITimeIdBasedComponentDataItem::setValue	(	int	timeIndex,
		int	idIndex,
		const void *	data
	)

pure virtual

Sets a single value for given id dimension index.

Parameters

timeIndex	is the time dimension index from where to obtain the requested data.
idIndex	is the id dimension index where data is to be written.
data	is the pointer to a pre-allocated location where data to be written.

◆ setValues()

virtual void HydroCouple::Temporal::ITimeIdBasedComponentDataItem::setValues	(	int	timeIndex,
		int	idIndex,
		int	timeStride,
		int	idStride,
		const void *	data
	)

pure virtual

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

Parameters

timeIndex	is the time dimension index from where to obtain the requested data.
idIndex	is the id dimension index where data is to be written.
timeStride	is the size for hyperslab where data is to be written.
idStride	is the size for hyperslab where data is to be written.
data	is the input 1d array to be written.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ITimeIdBasedComponentDataItem()

Member Function Documentation

◆ getValue()

◆ getValues()

◆ identifierDimension()

◆ identifiers()

◆ setValue()

◆ setValues()