HydroCouple::IAdaptedOutputFactory Class Reference

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 ()=0
	IAdaptedOutputFactory::~IAdaptedOutputFactory is a virtual destructor. More...
virtual vector< 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 IAdaptedOutput *	createAdaptedOutput (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 ()=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...

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

~IAdaptedOutputFactory()

virtual HydroCouple::IAdaptedOutputFactory::~IAdaptedOutputFactory ( )

pure virtual

IAdaptedOutputFactory::~IAdaptedOutputFactory is a virtual destructor.

Member Function Documentation

createAdaptedOutput()

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 IIdentifier instances returned by the createAdaptedProducerItem method. The returned IAdaptedOutputs will already be registered with the producer.

Parameters

adaptedProviderId	is an identifier of the IAdaptedOutput to create.
provider	IOutput to adapt.
consumer	IInput to adapt the adaptee to.

Returns

An IAdaptedOutput.

getAvailableAdaptedOutputIds()

virtual vector<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

provider	is the IOutput to adapt.
consumer	is the IInput to adapt the producer to, can be NULL.

Returns

A vector of identifiers for the available IAdaptedOutputs.

---

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

• /home/runner/work/HydroCouple/HydroCouple/HydroCouple/include/hydrocouple.h