HydroCouple::IIdentity Class Reference

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 ()=default
	IIdentity::~IIdentity is a virtual destructor.
virtual const std::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 const std::string &	caption () const =0
	Gets caption for the entity.
virtual void	setCaption (const std::string &caption)=0
	Sets caption for the entity.
virtual const std::string &	description () const =0
	Gets additional descriptive information for the entity.
virtual void	setDescription (const std::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< std::string >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.
virtual void	connect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.
virtual void	disconnect (const std::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< std::string >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

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

~IIdentity()

virtual HydroCouple::IIdentity::~IIdentity ( )

virtualdefault

IIdentity::~IIdentity is a virtual destructor.

Member Function Documentation

id()

virtual const std::string & 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 id must be unique within its context. It must not be empty.

---

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

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