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

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 ()
 
virtual IModelComponentcreateComponentInstance ()=0
 Creates a new IModelComponent instance. More...
 
virtual QList< 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 ()
 
virtual QString libraryFilePath () const =0
 File path to Component library. More...
 
virtual void setLibraryFilePath (const QString &filePath)=0
 Sets file path to Component library. More...
 
virtual QString iconFilePath () const =0
 File path to Component icon. Must be specified relative to the component library. More...
 
virtual QString vendor () const =0
 Component developer information. More...
 
virtual QStringList documentation () const =0
 Documentation associated with this component. More...
 
virtual QString license () const =0
 Component license info. More...
 
virtual QString copyright () const =0
 Component copyright info. More...
 
virtual QString url () const =0
 Component developer url. More...
 
virtual QString email () const =0
 Component developer email. More...
 
virtual QString version () const =0
 Component version info. More...
 
virtual QString category () const =0
 Component category. More...
 
virtual bool hasValidLicense () const =0
 hasValidLicense More...
 
virtual bool validateLicense (const QString &licenseInfo, QString &validationMessage)=0
 Checks if license is valid. More...
 
virtual bool validateLicense (QString &validationMessage)=0
 validateLicense 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

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

virtual HydroCouple::IModelComponentInfo::~IModelComponentInfo ( )
inlinevirtual

Member Function Documentation

virtual QList<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.
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: