IQuality describes qualitative data, where a value is specified as one category within a number of predefined (possible) categories. These categories can be ordered or not. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IQuality:

Collaboration diagram for HydroCouple::IQuality:

Public Member Functions
virtual	~IQuality ()=default
	IQuality::~IQuality is a virtual destructor.

virtual std::vector< std::string >	categories () const =0
	The possible category labels allowed for this IQuality.

virtual bool	isOrdered () const =0
	Checks if the IQuality is defined by an ordered set of ICategory or not.

Public Member Functions inherited from HydroCouple::IValueDefinition
virtual	~IValueDefinition ()=default
	~IValueDefinition destructor

virtual const std::type_info &	type () const =0
	Gets the object types of value that will be available and is returned by the GetValues function.

virtual double	missingValue () const =0
	The value representing that data is missing.

virtual double	defaultValue () const =0
	Gets the default value for this value definition.

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

IQuality describes qualitative data, where a value is specified as one category within a number of predefined (possible) categories. These categories can be ordered or not.

Qualitative data describes items in terms of some quality or categorization that may be 'informal' or may use relatively ill-defined characteristics such as warmth and flavour. However, qualitative data can include well-defined aspects such as gender, nationality or commodity type.

For qualitative data, the IComponentDataItem data exchanged between components contains one of the possible category instances per element in the IComponentDataItem involved.

Examples:

Colors: red, green, blue
Land use: nature, recreation, industry, infrastructure
Rating: worse, same, better

Constructor & Destructor Documentation

◆ ~IQuality()

virtual HydroCouple::IQuality::~IQuality ( )

virtualdefault

IQuality::~IQuality is a virtual destructor.

Member Function Documentation

◆ categories()

virtual std::vector< std::string > HydroCouple::IQuality::categories ( ) const

nodiscardpure virtual

The possible category labels allowed for this IQuality.

If the quality is not ordered the vector contains the categories in an unspecified order. When it is ordered the vector contains the categories in their defined sequence. Category values stored in the data item are indexes into this vector.

Returns: The category labels.

◆ isOrdered()

virtual bool HydroCouple::IQuality::isOrdered ( ) const

nodiscardpure virtual

Checks if the IQuality is defined by an ordered set of ICategory or not.

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

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