The IIdBasedComponentItem class is an idbased IComponentItem. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IIdBasedComponentDataItem:

Collaboration diagram for HydroCouple::IIdBasedComponentDataItem:

Public Member Functions
virtual	~IIdBasedComponentDataItem ()=0
	IIdBasedComponentItem::~IIdBasedComponentItem is a virtual destructor. More...

virtual list< string >	identifiers () const =0
	identifiers More...

virtual IDimension *	identifierDimension () const =0
	idDimensions More...

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

virtual void	getValues (int idIndex, int stride, 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 idIndex, const void *data)=0
	Sets a multi-dimensional array of values for given time dimension index and size for a hyperslab. More...

virtual void	setValues (int idIndex, int stride, 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...

Detailed Description

The IIdBasedComponentItem class is an idbased IComponentItem.

Constructor & Destructor Documentation

◆ ~IIdBasedComponentDataItem()

virtual HydroCouple::IIdBasedComponentDataItem::~IIdBasedComponentDataItem ( )

pure virtual

IIdBasedComponentItem::~IIdBasedComponentItem is a virtual destructor.

Member Function Documentation

◆ getValue()

virtual void HydroCouple::IIdBasedComponentDataItem::getValue	(	int	idIndex,
		void *	data
	)		const

pure virtual

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

Parameters

idIndex	is the id dimension index from where to obtain the requested data.
data	is pre-allocated memory where the data will be written.

◆ getValues()

virtual void HydroCouple::IIdBasedComponentDataItem::getValues	(	int	idIndex,
		int	stride,
		void *	data
	)		const

pure virtual

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

Parameters

idIndex	is the id dimension index from where to obtain the requested data.
stride	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::IIdBasedComponentDataItem::identifierDimension ( ) const

pure virtual

idDimensions

Returns

◆ identifiers()

virtual list<string> HydroCouple::IIdBasedComponentDataItem::identifiers ( ) const

pure virtual

identifiers

Returns

◆ setValue()

virtual void HydroCouple::IIdBasedComponentDataItem::setValue	(	int	idIndex,
		const void *	data
	)

pure virtual

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

Parameters

idIndex	is the id dimension index where data is to be written.
data	is the pre-allocated location where data is to be set.

◆ setValues()

virtual void HydroCouple::IIdBasedComponentDataItem::setValues	(	int	idIndex,
		int	stride,
		const void *	data
	)

pure virtual

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

Parameters

idIndex	is the id dimension index where data is to be written.
stride	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/hydrocouple.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IIdBasedComponentDataItem()

Member Function Documentation

◆ getValue()

◆ getValues()

◆ identifierDimension()

◆ identifiers()

◆ setValue()

◆ setValues()