HydroCouple::IDescription Class Reference

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 ()=0
	IDescription::~IDescription is a virtual destructor. More...
virtual string	caption () const =0
	Gets caption for the entity. More...
virtual void	setCaption (const string &caption)=0
	Sets caption for the entity. More...
virtual string	description () const =0
	Gets additional descriptive information for the entity. More...
virtual void	setDescription (const string &description)=0
	Gets additional descriptive information for the entity. More...
Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=0
	IPropertyChanged::~IPropertyChanged is a virtual destructor. More...
virtual void	registerPropertyChangedListener (const function< void(const any &, const string &)> &propertyChangedListener)=0
	IPropertyChanged::registerPropertyChangedListener() registers a listener to be called when a property of an object changes. More...
virtual void	deRegisterPropertyChangedListener (const function< void(const any &, const string &propertyName)> &propertyChangedListener)=0
	IPropertyChanged::deRegisterPropertyChangedListener() deregisters a listener that is called when a property of an object 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

~IDescription()

virtual HydroCouple::IDescription::~IDescription ( )

pure virtual

IDescription::~IDescription is a virtual destructor.

Member Function Documentation

caption()

virtual string HydroCouple::IDescription::caption ( ) const

pure virtual

Gets caption for the entity.

Returns

string representing caption for entity.

See also

setCaption()

description()

virtual string HydroCouple::IDescription::description ( ) const

pure virtual

Gets additional descriptive information for the entity.

Returns

string description of entity.

See also

setDescription()

setCaption()

virtual void HydroCouple::IDescription::setCaption ( const string &  caption )

pure virtual

Sets caption for the entity.

Parameters

caption

is a string representing the caption for the entity.

See also

caption()

setDescription()

virtual void HydroCouple::IDescription::setDescription ( const string &  description )

pure virtual

Gets additional descriptive information for the entity.

Parameters

description

is a string for describing an entity.

See also

description()

---

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

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