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

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IAdaptedOutputFactory:

Collaboration diagram for HydroCouple::IAdaptedOutputFactory:

Public Member Functions
virtual	~IAdaptedOutputFactory ()=default
	IAdaptedOutputFactory::~IAdaptedOutputFactory is a virtual destructor.

virtual std::vector< IIdentity * >	getAvailableAdaptedOutputIds (const IOutput provider, const IInput consumer=nullptr)=0
	Get a vector of IIdentity objects representing the vector of IAdaptedOutput instances that can be created by this factory. of the available IAdaptedOutput that can make the producer match the consumer.

virtual std::unique_ptr< IAdaptedOutput >	createAdaptedOutput (IIdentity adaptedProviderId, IOutput provider, IInput *consumer=nullptr)=0
	Creates a IAdaptedOutput that adapts the producer so that it fits the consumer.

Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=default
	IIdentity::~IIdentity is a virtual destructor.

virtual const std::string &	id () const =0
	Gets a unique identifier for the entity.

Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=default
	IDescription::~IDescription is a virtual destructor.

virtual const std::string &	caption () const =0
	Gets caption for the entity.

virtual void	setCaption (const std::string &caption)=0
	Sets caption for the entity.

virtual const std::string &	description () const =0
	Gets additional descriptive information for the entity.

virtual void	setDescription (const std::string &description)=0
	Gets additional descriptive information for the entity.

Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=default
	IPropertyChanged::~IPropertyChanged is a virtual destructor.

Public Member Functions inherited from HydroCouple::ISignal< std::string >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.

virtual void	connect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.

virtual void	disconnect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	disconnect is used to disconnect a slot from the signal.

virtual void	blockSignals (bool block)=0
	blockSignals is used to block signals from being emitted.

Additional Inherited Members
Protected Member Functions inherited from HydroCouple::ISignal< std::string >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

Detailed Description

IAdaptedOutputFactory is used to create instances of IAdaptedOutput.

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

Constructor & Destructor Documentation

◆ ~IAdaptedOutputFactory()

virtual HydroCouple::IAdaptedOutputFactory::~IAdaptedOutputFactory ( )

virtualdefault

IAdaptedOutputFactory::~IAdaptedOutputFactory is a virtual destructor.

Member Function Documentation

◆ createAdaptedOutput()

virtual std::unique_ptr< 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 IIdentity instances returned by the getAvailableAdaptedOutputIds() method. The returned IAdaptedOutput will already be registered with the provider.

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 std::vector< IIdentity * > HydroCouple::IAdaptedOutputFactory::getAvailableAdaptedOutputIds	(	const IOutput *	provider,
		const IInput *	consumer = `nullptr`
	)

pure virtual

Get a vector of IIdentity objects representing the vector of IAdaptedOutput instances that can be created by this factory. 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.