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 ()=0
	IIdentity::~IIdentity is a virtual destructor. More...
virtual string	id () const =0
	Gets a unique identifier for the entity. More...
Public Member Functions inherited from HydroCouple::IDescription
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

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

pure virtual

IIdentity::~IIdentity is a virtual destructor.

Member Function Documentation

id()

virtual 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