 |
HydroCouple
2.0.0
HydroCouple Interface Definitions
|
|
HydroCouple
2.0.0
HydroCouple Interface Definitions
|
The IMultiInput class is an IInput class that has multiple outputs supplying data to it. More...
#include <hydrocouple.h>
Public Member Functions | |
| virtual | ~IMultiInput ()=0 |
| IMultiInput::~IMultiInput is a virtual destructor. More... | |
| virtual vector< IOutput * > | providers () const =0 |
| providers More... | |
| virtual bool | addProvider (IOutput *provider)=0 |
| addProvider More... | |
| virtual bool | removeProvider (IOutput *provider)=0 |
| removeProvider More... | |
 Public Member Functions inherited from HydroCouple::IInput | |
| virtual | ~IInput ()=0 |
| IInput::~IInput is a virtual destructor. More... | |
| virtual IOutput * | provider () const =0 |
| Gets the producer this consumer should get its values from. More... | |
| virtual bool | setProvider (IOutput *provider)=0 |
| Sets the producer this consumer should get its values from. More... | |
| virtual bool | canConsume (IOutput *provider, string &message) const =0 |
| Returns true if this IInput can consume this producer. More... | |
| Public Member Functions inherited from HydroCouple::IExchangeItem | |
| virtual | ~IExchangeItem ()=0 |
| IExchangeItem::~IExchangeItem is a virtual destructor. More... | |
| virtual void | registerExchangeItemStatusChangedListener (const function< void(const shared_ptr< IExchangeItemChangeEventArgs > &)> &exchangeItemChangedEventListener)=0 |
| The componentItemChanged event is fired when the content of an IComponentItem has changed. More... | |
| virtual void | deRegisterExchangeItemStatusChangedListener (const function< void(const shared_ptr< IExchangeItemChangeEventArgs > &)> &exchangeItemChangedEventListener)=0 |
| The deRegisterExchangeItemStatusChangedListener() method deregisters a listener that is called when the status of the component changes. 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... | |
The IMultiInput class is an IInput class that has multiple outputs supplying data to it.
|
pure virtual |
IMultiInput::~IMultiInput is a virtual destructor.
|
pure virtual |
addProvider
| provider |
|
pure virtual |
providers
|
pure virtual |
removeProvider
| provider |
1.9.1