IComponentInfo interface class is a factory that provides detailed metadata about a component and creates new instances of a component. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IComponentInfo:

Collaboration diagram for HydroCouple::IComponentInfo:

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

virtual string	libraryFilePath () const =0
	File path to Component library.

virtual void	setLibraryFilePath (const string &filePath)=0
	Sets file path to Component library.

virtual string	iconFilePath () const =0
	File path to Component icon. Must be specified relative to the component library.

virtual string	developer () const =0
	Component developer information.

virtual list< string >	documentation () const =0
	Documentation associated with this component.

virtual string	license () const =0
	Component license info.

virtual string	copyright () const =0
	Component copyright info.

virtual string	url () const =0
	Component developer url.

virtual string	email () const =0
	Component developer email.

virtual string	version () const =0
	Component version info.

virtual set< string >	tags () const =0
	tags used to classify this component.

virtual bool	validateLicense (const string &licenseInfo, string &validationMessage)=0
	Checks if license is valid and persists license information.

virtual bool	validateLicense (string &validationMessage)=0
	validateLicense Checks if component is licensed and returns.

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

virtual 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 string	caption () const =0
	Gets caption for the entity.

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

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

virtual void	setDescription (const 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< string >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.

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

virtual void	disconnect (const 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< string >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

Detailed Description

IComponentInfo interface class is a factory that provides detailed metadata about a component and creates new instances of a component.

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

Constructor & Destructor Documentation

◆ ~IComponentInfo()

virtual HydroCouple::IComponentInfo::~IComponentInfo ( )

virtualdefault

IComponentInfo::~IComponentInfo is a virtual destructor.

Member Function Documentation

◆ copyright()

virtual string HydroCouple::IComponentInfo::copyright ( ) const

pure virtual

Component copyright info.

Returns: string representing the copyright information associated with this component.

◆ developer()

virtual string HydroCouple::IComponentInfo::developer ( ) const

pure virtual

Component developer information.

Returns: Name of developer/vendor the developed this component.

◆ documentation()

virtual list< string > HydroCouple::IComponentInfo::documentation ( ) const

pure virtual

Documentation associated with this component.

Returns: Citations of publication related to this component.

◆ email()

virtual string HydroCouple::IComponentInfo::email ( ) const

pure virtual

Component developer email.

Returns: email as string.

◆ iconFilePath()

virtual string 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.

◆ libraryFilePath()

virtual string HydroCouple::IComponentInfo::libraryFilePath ( ) const

pure virtual

File path to Component library.

Returns: Path to the library location from which this component was created.

See also: setLibraryFilePath()

◆ license()

virtual string HydroCouple::IComponentInfo::license ( ) const

pure virtual

Component license info.

Returns: string representing the license information. HTML tags can be added to it.

◆ setLibraryFilePath()

virtual void HydroCouple::IComponentInfo::setLibraryFilePath ( const string & filePath )

pure virtual

Sets file path to Component library.

Parameters

filePath to the libary from which this component was created.

See also: libraryFilePath()

◆ tags()

virtual set< string > HydroCouple::IComponentInfo::tags ( ) const

pure virtual

tags used to classify this component.

Returns: the categorical tags that can be used to classify components. e.g., Hydrology, Groundwater, Finite Volume, Finite difference.

◆ url()

virtual string HydroCouple::IComponentInfo::url ( ) const

pure virtual

Component developer url.

Returns: string representing the url for the developer.

◆ validateLicense() [1/2]

virtual bool HydroCouple::IComponentInfo::validateLicense	(	const string &	licenseInfo,
		string &	validationMessage
	)

pure virtual

Checks if license is valid and persists license information.

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

Parameters

[in]	licenseInfo	license information to use to register this component.
[out]	validationMessage	A validation message associated with the license validation process.

Returns: true if license is valid otherwise false.

◆ validateLicense() [2/2]

virtual bool HydroCouple::IComponentInfo::validateLicense ( string & validationMessage )

pure virtual

validateLicense Checks if component is licensed and returns.

Parameters

[out] validationMessage A validation message associated with the license validation process.

Returns: true if component is licensed otherwise false.

◆ version()

virtual string HydroCouple::IComponentInfo::version ( ) const

pure virtual

Component version info.

Returns: string representing the version of this component.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~IComponentInfo()

Member Function Documentation

◆ copyright()

◆ developer()

◆ documentation()

◆ email()

◆ iconFilePath()

◆ libraryFilePath()

◆ license()

◆ setLibraryFilePath()

◆ tags()

◆ url()

◆ validateLicense() [1/2]

◆ validateLicense() [2/2]

◆ version()