 |
HydroCouple
2.0.0
HydroCouple Interface Definitions
|
|
HydroCouple
2.0.0
HydroCouple Interface Definitions
|
IExchangeItem the base data item the can be exchanged between components at runtime. More...
#include <hydrocouple.h>
Public Member Functions | |
| virtual | ~IExchangeItem ()=default |
| IExchangeItem::~IExchangeItem is a virtual destructor. | |
 Public Member Functions inherited from HydroCouple::IComponentDataItem | |
| 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 vector< IDimension * > | dimensions () const =0 |
| provides purely descriptive information of the dimensions associated with this IComponentItem | |
| virtual int | dimensionLength (const initializer_list< 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 IValueSet defines the variable type associated with this object. | |
| virtual void | getValue (hydrocouple_variant &data, const initializer_list< 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, const initializer_list< int > &dimensionIndexes, const initializer_list< 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, const initializer_list< int > &dimensionIndexes)=0 |
| Sets a multi-dimensional array of values for given dimension indexes. | |
| virtual void | setValues (const hydrocouple_variant *data, const initializer_list< int > &dimensionIndexes, const initializer_list< 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 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 string | caption () const =0 |
| Gets caption for the entity. | |
| virtual void | setCaption (const string &caption)=0 |
| Sets caption for the entity. | |
| virtual string | description () const =0 |
| Gets additional descriptive information for the entity. | |
| virtual void | setDescription (const 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< string > | |
| virtual | ~ISignal ()=default |
| ISignal::~ISignal is a virtual destructor. | |
| virtual void | connect (const shared_ptr< ISlot< Args... > > &slot)=0 |
| connect is used to connect a slot to the signal. | |
| virtual void | disconnect (const 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 shared_ptr< IComponentDataItemValueChanged > & > | |
| virtual | ~ISignal ()=default |
| ISignal::~ISignal is a virtual destructor. | |
| virtual void | connect (const shared_ptr< ISlot< Args... > > &slot)=0 |
| connect is used to connect a slot to the signal. | |
| virtual void | disconnect (const 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< string > | |
| virtual void | emit (Args... args)=0 |
| emit is used to emit the signal. | |
| Protected Member Functions inherited from HydroCouple::ISignal< const shared_ptr< IComponentDataItemValueChanged > & > | |
| virtual void | emit (Args... args)=0 |
| emit is used to emit the signal. | |
IExchangeItem the base data item the can be exchanged between components at runtime.
This interface is not to be implemented directly, any class is to implement either the IInput or IOutput.
|
virtualdefault |
IExchangeItem::~IExchangeItem is a virtual destructor.
1.9.8