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

IAdaptedOutputFactory is used to create instances of IAdaptedProducerExchangeItems. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IAdaptedOutputFactory:
Collaboration diagram for HydroCouple::IAdaptedOutputFactory:

Public Member Functions

virtual ~IAdaptedOutputFactory ()
 
virtual QList< IIdentity * > getAvailableAdaptedOutputIds (const IOutput *provider, const IInput *consumer=nullptr)=0
 Get a list of IIdentity objects representing the list of the available IAdaptedOutput that can make the producer match the consumer. More...
 
virtual IAdaptedOutputcreateAdaptedOutput (IIdentity *adaptedProviderId, IOutput *provider, IInput *consumer=nullptr)=0
 Creates a IAdaptedOutput that adapts the producer so that it fits the consumer. 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::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

IAdaptedOutputFactory is used to create instances of IAdaptedProducerExchangeItems.

This class can be internal to an IModelComponent by calling IModelComponent::adaptedOutputFactories() or can be generated from an HydroCouple::IAdaptedOutputFactoryComponent.

Constructor & Destructor Documentation

virtual HydroCouple::IAdaptedOutputFactory::~IAdaptedOutputFactory ( )
inlinevirtual

Member Function Documentation

virtual IAdaptedOutput* HydroCouple::IAdaptedOutputFactory::createAdaptedOutput ( IIdentity adaptedProviderId,
IOutput provider,
IInput consumer = nullptr 
)
pure virtual

Creates a IAdaptedOutput that adapts the producer so that it fits the consumer.

The adaptedProviderId used must be one of the IHIdentifier instances returned by the createAdaptedProducerItem method. The returned IAdaptedOutputs will already be registered with the producer.

Parameters
adaptedProviderIdis an identifier of the IAdaptedOutput to create.
providerIOutput to adapt.
consumerIInput to adapt the adaptee to, can be NULL.
Returns
An IAdaptedOutput.
virtual QList<IIdentity*> HydroCouple::IAdaptedOutputFactory::getAvailableAdaptedOutputIds ( const IOutput provider,
const IInput consumer = nullptr 
)
pure virtual

Get a list of IIdentity objects representing the list of the available IAdaptedOutput that can make the producer match the consumer.

If the consumer is NULL, the identifiers of all IAdaptedOutputs that can adapt the producer are returned.

Parameters
provideris the IOutput to adapt.
consumeris the IInput to adapt the producer to, can be NULL.
Returns
A list of identifiers for the available IAdaptedOutputs.

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