HydroCouple::IQuantity Class Reference

IQuantity specifies values as an amount of some unit, usually as a floating point number. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IQuantity:

Collaboration diagram for HydroCouple::IQuantity:

Public Member Functions
virtual	~IQuantity ()=default
	IQuantity::~IQuantity is a virtual destructor.
virtual IUnit *	unit () const =0
	Unit of quantity.
virtual double	minValue () const =0
	Gets the minimum allowed value for this quantity.
virtual double	maxValue () const =0
	Gets the maximum allowed value for this quantity.
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

IQuantity specifies values as an amount of some unit, usually as a floating point number.

Constructor & Destructor Documentation

~IQuantity()

virtual HydroCouple::IQuantity::~IQuantity ( )

virtualdefault

IQuantity::~IQuantity is a virtual destructor.

Member Function Documentation

maxValue()

virtual double HydroCouple::IQuantity::maxValue ( ) const

nodiscardpure virtual

Gets the maximum allowed value for this quantity.

Returns

The maximum value.

minValue()

virtual double HydroCouple::IQuantity::minValue ( ) const

nodiscardpure virtual

Gets the minimum allowed value for this quantity.

Returns

The minimum value.

unit()

virtual IUnit * HydroCouple::IQuantity::unit ( ) const

nodiscardpure virtual

Unit of quantity.

---

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

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