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

An IAdaptedOutput adds one or more data operations on top of an IOutput. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IAdaptedOutput:
Collaboration diagram for HydroCouple::IAdaptedOutput:

Public Member Functions

virtual ~IAdaptedOutput ()
 
virtual IAdaptedOutputFactoryadaptedOutputFactory () const =0
 IAdaptedOutputFactory that generated this IAdaptedOutput. More...
 
virtual QList< IArgument * > arguments () const =0
 IArgument represents input parameters needed for this IAdaptedOutput. More...
 
virtual void initialize ()=0
 Lets this IAdaptedOutput initialize() itself, based on the current values specified by the arguments. More...
 
virtual IOutputadaptee () const =0
 IOutput that this IAdaptedOutput extracts content from. In the adapter design pattern, it is the item being adapted. More...
 
virtual void refresh ()=0
 Requests the IAdaptedOutput to refresh itself and perform any necessary calculations. More...
 
- Public Member Functions inherited from HydroCouple::IOutput
virtual ~IOutput ()
 
virtual QList< IInput * > consumers () const =0
 Input items that will consume the values, by calling the GetValues() method. More...
 
virtual void addConsumer (IInput *consumer)=0
 Add a consumer to this output item. Every input item that wants to call the IValueSet::getValue() method, needs to add itself as a consumer first. More...
 
virtual bool removeConsumer (IInput *consumer)=0
 Remove a consumer. More...
 
virtual QList< IAdaptedOutput * > adaptedOutputs () const =0
 The adaptedOutputs that have this current output item as adaptee. More...
 
virtual void addAdaptedOutput (IAdaptedOutput *adaptedOutput)=0
 Add a IAdaptedOutput to this output item. More...
 
virtual bool removeAdaptedOutput (IAdaptedOutput *adaptedOutput)=0
 Removes an IAdaptedOutput. More...
 
virtual void updateValues (IInput *querySpecifier)=0
 Provides the values matching the value definition specified by the

Parameters
querySpecifier

. Extensions can overwrite this base version to include more details in the query, e.g. time and space. More...

 
- Public Member Functions inherited from HydroCouple::IExchangeItem
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 ()
 

Additional Inherited Members

- Signals inherited from HydroCouple::IExchangeItem
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...
 

Detailed Description

An IAdaptedOutput adds one or more data operations on top of an IOutput.

It is in itself an IOutput. The IAdaptedOutput extends an output with operations including spatial interpolation, temporal interpolation, unit conversion etc.

IAdaptedOutput instances are created by means of an IAdaptedOutputFactory.

The IAdaptedOutput is based on the adaptor design pattern. It adapts an IOutput or another IAdaptedOutput to make it suitable for new use or purpose. The object being adapted is typically called the adaptee. The IAdaptedOutput replaces the DataOperation that was used in OpenMI Standard version 1.x.

Constructor & Destructor Documentation

virtual HydroCouple::IAdaptedOutput::~IAdaptedOutput ( )
inlinevirtual

Member Function Documentation

virtual IAdaptedOutputFactory* HydroCouple::IAdaptedOutput::adaptedOutputFactory ( ) const
pure virtual

IAdaptedOutputFactory that generated this IAdaptedOutput.

Returns
IAdaptedOutputFactory parent.
virtual IOutput* HydroCouple::IAdaptedOutput::adaptee ( ) const
pure virtual

IOutput that this IAdaptedOutput extracts content from. In the adapter design pattern, it is the item being adapted.

Returns
an IOutput that is being modified by this IAdaptedOutput.
virtual QList<IArgument*> HydroCouple::IAdaptedOutput::arguments ( ) const
pure virtual

IArgument represents input parameters needed for this IAdaptedOutput.

An unmodifiable list of the (modifiable) IArguments should be returned that can be used to get information on an IArgument and to modify its values. Validation of changes is done when they occur (e.g. using notifications).

Returns
Unmodifiable list of IArgument for the adapted output.
virtual void HydroCouple::IAdaptedOutput::initialize ( )
pure virtual

Lets this IAdaptedOutput initialize() itself, based on the current values specified by the arguments.

Only after initialize() is called the refresh() method might be called.

A component must invoke the initialize() method of all its adapted outputs at the end of the component's Prepare phase. In case of stacked adapted outputs, the adaptee must be initialized first.

virtual void HydroCouple::IAdaptedOutput::refresh ( )
pure virtual

Requests the IAdaptedOutput to refresh itself and perform any necessary calculations.

This method will be called by the adaptee(), when it has been refreshed/updated. In the implementation of the refresh method the adapted output should update its contents according to the cha

After updating itself the IAdaptedOutput must call refresh() on all its IAdaptedOutput children, nges in the adaptee. so the chain of IOutput 's refreshes themselves.


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