The IVectorComponentDataItem class. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IVectorComponentDataItem:

Collaboration diagram for HydroCouple::Spatial::IVectorComponentDataItem:

Public Member Functions
virtual	~IVectorComponentDataItem ()=0
	~IVectorComponentDataItem More...

virtual int	locationsCount () const =0
	locationCount represents the number of locations. More...

virtual IPoint *	location (int locationIndex) const =0
	location returns the IPoint at the given location index. More...

virtual IDimension *	locationsDimension () const =0
	locationsDimension represents the dimension for the locations. 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 locationIndex, int spatialDimensionIndex, void *data) const =0
	getValue for given location index and spatial dimension index. More...

virtual void	getValues (int locationIndex, int spatialDimensionIndex, int locationStride, int spatialDimensionStride, void *data) const =0
	getValues for given location index and spatial dimension index. More...

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

virtual void	setValues (int locationIndex, int spatialDimensionIndex, int locationStride, int spatialDimensionStride, const void *data)=0
	setValues for given location index and spatial dimension index. 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 IVectorComponentDataItem class.

Constructor & Destructor Documentation

◆ ~IVectorComponentDataItem()

virtual HydroCouple::Spatial::IVectorComponentDataItem::~IVectorComponentDataItem ( )

pure virtual

~IVectorComponentDataItem

Member Function Documentation

◆ getValue()

virtual void HydroCouple::Spatial::IVectorComponentDataItem::getValue	(	int	locationIndex,
		int	spatialDimensionIndex,
		void *	data
	)		const

pure virtual

getValue for given location index and spatial dimension index.

Parameters

locationIndex	is the location index from where to obtain the requested data.
spatialDimensionIndex	is the spatial dimension index from where to obtain the requested data.
data	is a pointer to data that is to be written. Must be allocated beforehand with the correct data type.

◆ getValues()

virtual void HydroCouple::Spatial::IVectorComponentDataItem::getValues	(	int	locationIndex,
		int	spatialDimensionIndex,
		int	locationStride,
		int	spatialDimensionStride,
		void *	data
	)		const

pure virtual

getValues for given location index and spatial dimension index.

Parameters

locationIndex	is the location 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 hyperslab from which to copy data.
spatialDimensionStride	is the size for hyperslab from which to copy data.
data	is a multi dimensional array where data is to be written. Must be allocated beforehand with the correct data type.

◆ location()

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

pure virtual

location returns the IPoint at the given location index.

Parameters

locationIndex is the location index from where to obtain the requested data.

Returns

◆ locationsCount()

virtual int HydroCouple::Spatial::IVectorComponentDataItem::locationsCount ( ) const

pure virtual

locationCount represents the number of locations.

Returns: The number of locations.

◆ locationsDimension()

virtual IDimension* HydroCouple::Spatial::IVectorComponentDataItem::locationsDimension ( ) const

pure virtual

locationsDimension represents the dimension for the locations.

Returns: The dimension for the locations.

◆ setValue()

virtual void HydroCouple::Spatial::IVectorComponentDataItem::setValue	(	int	locationIndex,
		int	spatialDimensionIndex,
		const void *	data
	)

pure virtual

setValue for given location index and spatial dimension index.

Parameters

locationIndex	is the location index from where to write data.
spatialDimensionIndex	is the spatial dimension index from where to write data.
data	is a pointer data thata to is to be copied

◆ setValues()

virtual void HydroCouple::Spatial::IVectorComponentDataItem::setValues	(	int	locationIndex,
		int	spatialDimensionIndex,
		int	locationStride,
		int	spatialDimensionStride,
		const void *	data
	)

pure virtual

setValues for given location index and spatial dimension index.

Parameters

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

◆ spatialDimension()

virtual IDimension* HydroCouple::Spatial::IVectorComponentDataItem::spatialDimension ( ) const

pure virtual

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

Returns: The dimension for the data type.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IVectorComponentDataItem()

Member Function Documentation

◆ getValue()

◆ getValues()

◆ location()

◆ locationsCount()

◆ locationsDimension()

◆ setValue()

◆ setValues()

◆ spatialDimension()