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

IComponentInfo interface class provides detailed metadata about a component. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IComponentInfo:
Collaboration diagram for HydroCouple::IComponentInfo:

Public Member Functions

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

IComponentInfo interface class provides detailed metadata about a component.

It must not be implemented directly. It must be either be implemented as an IModelComponent or an Data::IAdaptedOutputFactoryComponent.

Constructor & Destructor Documentation

virtual HydroCouple::IComponentInfo::~IComponentInfo ( )
inlinevirtual

Member Function Documentation

virtual QString HydroCouple::IComponentInfo::category ( ) const
pure virtual

Component category.

Returns
the category that this component belongs to. Sub-categories can be specified by separating categories using the backslash e.g., Hydrology\Snowmelt.
virtual QString HydroCouple::IComponentInfo::copyright ( ) const
pure virtual

Component copyright info.

Returns
QString representing the copyright information associated with this component.
virtual QStringList HydroCouple::IComponentInfo::documentation ( ) const
pure virtual

Documentation associated with this component.

Returns
Citations of publication related to this component.
virtual QString HydroCouple::IComponentInfo::email ( ) const
pure virtual

Component developer email.

Returns
email as QString.
virtual bool HydroCouple::IComponentInfo::hasValidLicense ( ) const
pure virtual

hasValidLicense

Returns
virtual QString HydroCouple::IComponentInfo::iconFilePath ( ) const
pure virtual

File path to Component icon. Must be specified relative to the component library.

Returns
filePath to icon for component.
virtual QString HydroCouple::IComponentInfo::libraryFilePath ( ) const
pure virtual

File path to Component library.

Returns
Path to the library location from which this component was created.
virtual QString HydroCouple::IComponentInfo::license ( ) const
pure virtual

Component license info.

Returns
QString representing the license information. HTML tags can be added to it.
virtual void HydroCouple::IComponentInfo::setLibraryFilePath ( const QString &  filePath)
pure virtual

Sets file path to Component library.

Parameters
filePathto the libary from which this component was created.
virtual QString HydroCouple::IComponentInfo::url ( ) const
pure virtual

Component developer url.

Returns
QString representing the url for the developer.
virtual bool HydroCouple::IComponentInfo::validateLicense ( const QString &  licenseInfo,
QString &  validationMessage 
)
pure virtual

Checks if license is valid.

Developer is responsible for implementing this validation based on a license.

Parameters
licenseInfolicense information to use to register this component.
validationMessageA validation message associated with the license validation process.
Returns
true if license is valid otherwise false.
virtual bool HydroCouple::IComponentInfo::validateLicense ( QString &  validationMessage)
pure virtual

validateLicense

Parameters
validationMessage
Returns
virtual QString HydroCouple::IComponentInfo::vendor ( ) const
pure virtual

Component developer information.

Returns
Name of vendor the developed this component.
virtual QString HydroCouple::IComponentInfo::version ( ) const
pure virtual

Component version info.

Returns
QString representing the version of this component.

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