IComponentDataItem is a fundamental unit of data for a component. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IComponentDataItem:

Collaboration diagram for HydroCouple::IComponentDataItem:

Public Member Functions
virtual	~IComponentDataItem ()=default
	IComponentDataItem::~IComponentDataItem is a virtual destructor.

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.

virtual std::vector< IDimension * >	dimensions () const =0
	provides purely descriptive information of the dimensions associated with this IComponentItem

virtual int	dimensionLength (std::span< const 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()

virtual IValueDefinition *	valueDefinition () const =0
	IValueDefinition for this IComponentDataItem defines the variable type associated with this object.

virtual void	getValue (hydrocouple_variant &data, std::span< const int >dimensionIndexes) const =0
	Gets a multi-dimensional array of values for given dimension indexes and strides along each dimension. IndexArray = x + y * InSizeX + z * InSizeX * InSizeY etc;.

virtual void	getValues (hydrocouple_variant *data, std::span< const int >dimensionIndexes, std::span< const int >dimensionLengths={}) const =0
	Gets a multi-dimensional array of values for given dimension indexes and strides along each dimension.

virtual void	setValue (const hydrocouple_variant &data, std::span< const int >dimensionIndexes)=0
	Sets a multi-dimensional array of values for given dimension indexes.

virtual void	setValues (const hydrocouple_variant *data, std::span< const int >dimensionIndexes, std::span< const int >dimensionLengths={})=0
	Sets a multi-dimensional array of values for given dimension indexes and strides along each dimension.

virtual bool	hasEditor () const =0
	hasEditor indicates whether this IComponentItem has a UI editor.

virtual void	showEditor (void *opaqueUIPointer=nullptr)=0
	showEditor shows the editor for this IComponentItem.

virtual bool	hasViewer () const =0
	hasViewer indicates whether this IComponentItem has a UI viewer.

virtual void	showViewer (void *opaqueUIPointer=nullptr)=0
	showViewer shows the viewer for this IComponentItem.

Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=default
	IIdentity::~IIdentity is a virtual destructor.

virtual const std::string &	id () const =0
	Gets a unique identifier for the entity.

Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=default
	IDescription::~IDescription is a virtual destructor.

virtual const std::string &	caption () const =0
	Gets caption for the entity.

virtual void	setCaption (const std::string &caption)=0
	Sets caption for the entity.

virtual const std::string &	description () const =0
	Gets additional descriptive information for the entity.

virtual void	setDescription (const std::string &description)=0
	Gets additional descriptive information for the entity.

Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=default
	IPropertyChanged::~IPropertyChanged is a virtual destructor.

Public Member Functions inherited from HydroCouple::ISignal< std::string >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.

virtual void	connect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.

virtual void	disconnect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	disconnect is used to disconnect a slot from the signal.

virtual void	blockSignals (bool block)=0
	blockSignals is used to block signals from being emitted.

Public Member Functions inherited from HydroCouple::ISignal< const std::shared_ptr< IComponentDataItemValueChanged > & >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.

virtual void	connect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.

virtual void	disconnect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	disconnect is used to disconnect a slot from the signal.

virtual void	blockSignals (bool block)=0
	blockSignals is used to block signals from being emitted.

Additional Inherited Members
Protected Member Functions inherited from HydroCouple::ISignal< std::string >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

Protected Member Functions inherited from HydroCouple::ISignal< const std::shared_ptr< IComponentDataItemValueChanged > & >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

Detailed Description

IComponentDataItem is a fundamental unit of data for a component.

This interface is not to be implemented directly. Input and output data must be 1D arrays indexed using dim1 + dim2 * size1 + dim3 * size1 * size2 + dim4 * size1 * size2 * size3 + ...

See also: IExchangeItem, IArgument, IIdBasedComponentDataItem

Constructor & Destructor Documentation

◆ ~IComponentDataItem()

virtual HydroCouple::IComponentDataItem::~IComponentDataItem ( )

virtualdefault

IComponentDataItem::~IComponentDataItem is a virtual destructor.

Member Function Documentation

◆ dimensionLength()

virtual int HydroCouple::IComponentDataItem::dimensionLength ( std::span< const int > dimensionIndexes = {} ) const

pure virtual

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()

Parameters

[in] dimensionIndexes array of indexes of the dimensions to get the length of. Its size must be less than the number of dimensions.

Returns: length of the last dimension corresponding to the dimensionIndexes provided.

◆ dimensions()

virtual std::vector< IDimension * > HydroCouple::IComponentDataItem::dimensions ( ) const

pure virtual

provides purely descriptive information of the dimensions associated with this IComponentItem

Returns: A list of IDimension objects.

◆ getValue()

virtual void HydroCouple::IComponentDataItem::getValue	(	hydrocouple_variant &	data,
		std::span< const int >	dimensionIndexes
	)		const

pure virtual

Gets a multi-dimensional array of values for given dimension indexes and strides along each dimension. IndexArray = x + y * InSizeX + z * InSizeX * InSizeY etc;.

Parameters

[out]	data	Pointer to pre-allocated location where data is to be saved.
[in]	dimensionIndexes	are the indexes for the data to be obtained.

◆ getValues()

virtual void HydroCouple::IComponentDataItem::getValues	(	hydrocouple_variant *	data,
		std::span< const int >	dimensionIndexes,
		std::span< const int >	dimensionLengths = `{}`
	)		const

pure virtual

Gets a multi-dimensional array of values for given dimension indexes and strides along each dimension.

Parameters

[out]	data	Pointer to pre-allocated location where data is to be saved.
[in]	dimensionIndexes	are the indexes for the data to be obtained.
[in]	dimensionLengths	are the lengths of the dimensions for the data to be obtained. If empty a single value is returned, otherwise the length of the vector must be equal to the number of dimensions.

◆ hasEditor()

virtual bool HydroCouple::IComponentDataItem::hasEditor ( ) const

pure virtual

hasEditor indicates whether this IComponentItem has a UI editor.

Returns: A boolean indicating whether this IComponentItem has an editor.

◆ hasViewer()

virtual bool HydroCouple::IComponentDataItem::hasViewer ( ) const

pure virtual

hasViewer indicates whether this IComponentItem has a UI viewer.

Returns: A boolean indicating whether this IComponentItem has a viewer.

◆ modelComponent()

virtual IModelComponent * HydroCouple::IComponentDataItem::modelComponent ( ) const

pure virtual

Gets the owner IModelComponent of this IComponentItem. For an IOutput component item this is the component responsible for providing the content of the IOutput.

It is possible for an IComponentItem to have no owner, in this case the method will return nullptr.

Returns: an IModelComponent object that is the parent of this IComponentItem

◆ setValue()

virtual void HydroCouple::IComponentDataItem::setValue	(	const hydrocouple_variant &	data,
		std::span< const int >	dimensionIndexes
	)

pure virtual

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

Parameters

[in]	data	is the pointer to the input data to be set.
[in]	dimensionIndexes	are the indexes for where data is to be written.

◆ setValues()

virtual void HydroCouple::IComponentDataItem::setValues	(	const hydrocouple_variant *	data,
		std::span< const int >	dimensionIndexes,
		std::span< const int >	dimensionLengths = `{}`
	)

pure virtual

Sets a multi-dimensional array of values for given dimension indexes and strides along each dimension.

Parameters

[in]	data	is the pointer to the input data to be set.
[in]	dimensionIndexes	are the indexes for where data is to be written.
[in]	dimensionLengths	are the lengths of the dimensions for the data to be set. If empty a single value is set, otherwise the length of the vector must be equal to the number of dimensions.

◆ showEditor()

virtual void HydroCouple::IComponentDataItem::showEditor ( void * opaqueUIPointer = nullptr )

pure virtual

showEditor shows the editor for this IComponentItem.

Parameters

[in] opaqueUIPointer Is an opaque pointer to the UI object that is used to show the editor.

◆ showViewer()

virtual void HydroCouple::IComponentDataItem::showViewer ( void * opaqueUIPointer = nullptr )

pure virtual

showViewer shows the viewer for this IComponentItem.

Parameters

[in] opaqueUIPointer Is an opaque pointer to the UI object that is used to show the viewer.

◆ valueDefinition()

virtual IValueDefinition * HydroCouple::IComponentDataItem::valueDefinition ( ) const

pure virtual

IValueDefinition for this IComponentDataItem defines the variable type associated with this object.

Returns: The IValueDefinition for this data item (either an IQuality or IQuantity).

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~IComponentDataItem()

Member Function Documentation

◆ dimensionLength()

◆ dimensions()

◆ getValue()

◆ getValues()

◆ hasEditor()

◆ hasViewer()

◆ modelComponent()

◆ setValue()

◆ setValues()

◆ showEditor()

◆ showViewer()

◆ valueDefinition()