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 ()=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

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 ( )

virtualdefault

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

[in]

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

[in]

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