HydroCouple::IModelComponentInfo Class Reference

IModelComponentInfo interface inherits from the IComponentInfo interface which provides detailed metadata about an IModelComponent. Additionally, it creates new instances of a component. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IModelComponentInfo:

Collaboration diagram for HydroCouple::IModelComponentInfo:

Public Member Functions
virtual	~IModelComponentInfo ()=0
	IModelComponentInfo::~IModelComponentInfo is a virtual destructor. More...
virtual IModelComponent *	createComponentInstance ()=0
	Creates a new IModelComponent instance. More...
virtual vector< IAdaptedOutputFactory * >	adaptedOutputFactories () const =0
	Gets a list of IAdaptedOutputFactories, each allowing to create IAdaptedOutput item for making outputs fit to inputs in case they do not already do so. More...
Public Member Functions inherited from HydroCouple::IComponentInfo
virtual	~IComponentInfo ()=0
	IComponentInfo::~IComponentInfo is a virtual destructor. More...
virtual string	libraryFilePath () const =0
	File path to Component library. More...
virtual void	setLibraryFilePath (const string &filePath)=0
	Sets file path to Component library. More...
virtual string	iconFilePath () const =0
	File path to Component icon. Must be specified relative to the component library. More...
virtual string	vendor () const =0
	Component developer information. More...
virtual list< string >	documentation () const =0
	Documentation associated with this component. More...
virtual string	license () const =0
	Component license info. More...
virtual string	copyright () const =0
	Component copyright info. More...
virtual string	url () const =0
	Component developer url. More...
virtual string	email () const =0
	Component developer email. More...
virtual string	version () const =0
	Component version info. More...
virtual set< string >	tags () const =0
	tags used to classify this component. More...
virtual bool	validateLicense (const string &licenseInfo, string &validationMessage)=0
	Checks if license is valid and persists license information. More...
virtual bool	validateLicense (string &validationMessage)=0
	validateLicense Checks if component is licensed and returns. 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

IModelComponentInfo interface inherits from the IComponentInfo interface which provides detailed metadata about an IModelComponent. Additionally, it creates new instances of a component.

The IModelComponentInfo interface is used to provide metadata on a component and create new instances of a component.

Constructor & Destructor Documentation

~IModelComponentInfo()

virtual HydroCouple::IModelComponentInfo::~IModelComponentInfo ( )

pure virtual

IModelComponentInfo::~IModelComponentInfo is a virtual destructor.

Member Function Documentation

adaptedOutputFactories()

virtual vector<IAdaptedOutputFactory *> HydroCouple::IModelComponentInfo::adaptedOutputFactories ( ) const

pure virtual

Gets a list of IAdaptedOutputFactories, each allowing to create IAdaptedOutput item for making outputs fit to inputs in case they do not already do so.

Factories can be added to and removed from the list so that third-party factories and IAdaptedOutput classes can be introduced.

Returns

A list of IAdaptedOutputFactories associated with this component.

createComponentInstance()

virtual IModelComponent* HydroCouple::IModelComponentInfo::createComponentInstance ( )

pure virtual

Creates a new IModelComponent instance.

Returns

A new instance of an IModelComponent.

---

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

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