HydroCouple  1.0.0
Description of the HydroCouple Component-Based Model Coupling Interface Definitions
HydroCouple::IExchangeItem Class Referenceabstract

IExchangeItem the base data item the can be exchanged between components at runtime. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IExchangeItem:
Collaboration diagram for HydroCouple::IExchangeItem:

Signals

virtual void itemChanged (const QSharedPointer< IExchangeItemChangeEventArgs > &statusChangedEvent)=0
 The componentItemChanged event is fired when the content of an IComponentItem has changed. More...
 
- Signals inherited from HydroCouple::IPropertyChanged
virtual void propertyChanged (const QString &propertyName)=0
 IPropertyChanged::propertyChanged() is called to emit signal/event when property of child class changes. More...
 

Public Member Functions

virtual ~IExchangeItem ()
 
- Public Member Functions inherited from HydroCouple::IComponentDataItem
virtual ~IComponentDataItem ()
 
virtual IModelComponentmodelComponent () 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 QList< IDimension * > dimensions () const =0
 provides purely descriptive information of the dimensions associated with this IComponentItem More...
 
virtual int dimensionLength (const std::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 IValueDefinitionvalueDefinition () const =0
 IValueDefinition for this IValueSet defines the variable type associated with this object. More...
 
virtual void getValue (const std::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 std::vector< int > &dimensionIndexes, const void *data)=0
 Sets a multi-dimensional array of values for given dimension indexes. More...
 
- Public Member Functions inherited from HydroCouple::IIdentity
virtual ~IIdentity ()
 
virtual QString id () const =0
 Gets a unique identifier for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IDescription
virtual ~IDescription ()
 
virtual QString caption () const =0
 Gets caption for the entity. More...
 
virtual void setCaption (const QString &caption)=0
 Sets caption for the entity. More...
 
virtual QString description () const =0
 Gets additional descriptive information for the entity. More...
 
virtual void setDescription (const QString &description)=0
 Gets additional descriptive information for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual ~IPropertyChanged ()
 

Detailed Description

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.

Constructor & Destructor Documentation

virtual HydroCouple::IExchangeItem::~IExchangeItem ( )
inlinevirtual

Member Function Documentation

virtual void HydroCouple::IExchangeItem::itemChanged ( const QSharedPointer< IExchangeItemChangeEventArgs > &  statusChangedEvent)
pure virtualsignal

The componentItemChanged event is fired when the content of an IComponentItem has changed.

Parameters
statusChangedEventprovides information about the status change

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