The ITimeVectorComponentDataItem class. More...

#include <hydrocouplespatiotemporal.h>

Inheritance diagram for HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem:

Collaboration diagram for HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem:

Public Member Functions
virtual	~ITimeVectorComponentDataItem ()=0
	~ITimeVectorComponentItem. More...

virtual int	locationsCount () const =0
	locationCount More...

virtual HydroCouple::Spatial::IPoint *	location (int locationIndex) const =0
	location The location at the specified index. More...

virtual IDimension *	locationsDimension () const =0
	locationsDimension The dimension for the locations of the vector. More...

virtual IDimension *	spatialDimension () const =0
	dataTypeDimension alway has a length of 3. 0 = x-direction value, 1 = y-direction, 2 = z-direction, More...

virtual void	getValue (int timeIndex, int locationIndex, int spatialIndex, void *data) const =0
	getValue Gets the value for given time dimension index, location dimension index and spatial dimension index. More...

virtual void	getValues (int timeIndex, int locationIndex, int spatialDimensionIndex, int locationStride, int spatialDimensionStride, void *data) const =0
	getValues Gets a multi-dimensional array of values for given dimension for a hyperslab. More...

virtual void	setValue (int timeIndex, int locationIndex, int spatialDimensionIndex, const void *data)=0
	setValue Sets the value for given time dimension index, location dimension index and spatial dimension index. More...

virtual void	setValues (int timeIndex, int locationIndex, int spatialDimensionIndex, int locationStride, int spatialDimensionStride, const void *data)=0
	setValues Sets a multi-dimensional array of values for given dimension 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 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

The ITimeVectorComponentDataItem class.

Constructor & Destructor Documentation

◆ ~ITimeVectorComponentDataItem()

virtual HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem::~ITimeVectorComponentDataItem ( )

pure virtual

~ITimeVectorComponentItem.

Member Function Documentation

◆ getValue()

virtual void HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem::getValue	(	int	timeIndex,
		int	locationIndex,
		int	spatialIndex,
		void *	data
	)		const

pure virtual

getValue Gets the value for given time dimension index, location dimension index and spatial dimension index.

Parameters

timeIndex	is the time dimension index from where to obtain the requested data.
locationIndex	is the location dimension index from where to obtain the requested data.
spatialIndex	is the spatial dimension index from where to obtain the requested data.
data	is the array where data is to be written. Must be allocated beforehand with the correct data type.

◆ getValues()

virtual void HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem::getValues	(	int	timeIndex,
		int	locationIndex,
		int	spatialDimensionIndex,
		int	locationStride,
		int	spatialDimensionStride,
		void *	data
	)		const

pure virtual

getValues Gets a multi-dimensional array of values for given dimension for a hyperslab.

Parameters

timeIndex	is the time dimension index from where to obtain the requested data.
locationIndex	is the location dimension index from where to obtain the requested data.
spatialDimensionIndex	is the spatial dimension index from where to obtain the requested data.
locationStride	is the size for the location dimension for hyperslab from which to copy data.
spatialDimensionStride	is the size for the spatial dimension for hyperslab from which to copy data.
data	is the multi dimensional array where data is to be written. Must be allocated beforehand.

◆ location()

virtual HydroCouple::Spatial::IPoint* HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem::location ( int locationIndex ) const

pure virtual

location The location at the specified index.

Parameters

locationIndex The index of the location to return.

Returns: The location at the specified index.

◆ locationsCount()

virtual int HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem::locationsCount ( ) const

pure virtual

locationCount

Returns

◆ locationsDimension()

virtual IDimension* HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem::locationsDimension ( ) const

pure virtual

locationsDimension The dimension for the locations of the vector.

Returns: The dimension for the locations of the vector.

◆ setValue()

virtual void HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem::setValue	(	int	timeIndex,
		int	locationIndex,
		int	spatialDimensionIndex,
		const void *	data
	)

pure virtual

setValue Sets the value for given time dimension index, location dimension index and spatial dimension index.

Parameters

timeIndex	is the time dimension index where data is to be written.
locationIndex	is the location dimension index where data is to be written.
spatialDimensionIndex	is the spatial dimension index where data is to be written.
data	is the input array to be written.

◆ setValues()

virtual void HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem::setValues	(	int	timeIndex,
		int	locationIndex,
		int	spatialDimensionIndex,
		int	locationStride,
		int	spatialDimensionStride,
		const void *	data
	)

pure virtual

setValues Sets a multi-dimensional array of values for given dimension for a hyperslab.

Parameters

timeIndex	is the time dimension index where data is to be written.
locationIndex	is the location dimension index where data is to be written.
spatialDimensionIndex	is the spatial dimension index where data is to be written.
locationStride	is the size for the location dimension for hyperslab from which to copy data.
spatialDimensionStride	is the size for the spatial dimension for hyperslab from which to copy data.
data	is the input multi dimensional array to be written.

◆ spatialDimension()

virtual IDimension* HydroCouple::SpatioTemporal::ITimeVectorComponentDataItem::spatialDimension ( ) const

pure virtual

dataTypeDimension alway has a length of 3. 0 = x-direction value, 1 = y-direction, 2 = z-direction,

Returns

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ITimeVectorComponentDataItem()

Member Function Documentation

◆ getValue()

◆ getValues()

◆ location()

◆ locationsCount()

◆ locationsDimension()

◆ setValue()

◆ setValues()

◆ spatialDimension()