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

IDescription interface class provides descriptive information on a HydroCouple object. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IDescription:
Collaboration diagram for HydroCouple::IDescription:

Public Member Functions

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

IDescription interface class provides descriptive information on a HydroCouple object.

An entity that is describable has a caption (title or heading) and a description. These are not to be used for identification (see IIdentity).

Constructor & Destructor Documentation

virtual HydroCouple::IDescription::~IDescription ( )
inlinevirtual

Member Function Documentation

virtual QString HydroCouple::IDescription::caption ( ) const
pure virtual

Gets caption for the entity.

Returns
QString representing caption for entity.
virtual QString HydroCouple::IDescription::description ( ) const
pure virtual

Gets additional descriptive information for the entity.

Returns
QString description of entity.
virtual void HydroCouple::IDescription::setCaption ( const QString &  caption)
pure virtual

Sets caption for the entity.

Parameters
captionis a QString representing the caption for the entity.
virtual void HydroCouple::IDescription::setDescription ( const QString &  description)
pure virtual

Gets additional descriptive information for the entity.

Parameters
descriptionis a string for describing an entity.

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