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

IIdentity interface class defines a method to get the Id of an HydroCouple entity. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IIdentity:
Collaboration diagram for HydroCouple::IIdentity:

Public Member Functions

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

IIdentity interface class defines a method to get the Id of an HydroCouple entity.

IIdentity extends the IDescription interface class, and therefore has, next to the id, a caption and a description.

Constructor & Destructor Documentation

virtual HydroCouple::IIdentity::~IIdentity ( )
inlinevirtual

Member Function Documentation

virtual QString HydroCouple::IIdentity::id ( ) const
pure virtual

Gets a unique identifier for the entity.

An id must be unique within its context but does not need to be globally unique. For example, the id of an input exchange item must be unique in the list of inputs of a IModelComponent, but a similar Id might be used by an exchange item of another IModelComponent.

Returns
An id as a String.

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