HydroCouple::IUnit Class Reference

IUnit interface, describing the physical unit of a IQuantity. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IUnit:

Collaboration diagram for HydroCouple::IUnit:

Public Types
enum class	DistanceUnitType {   Standard ,   Geographic ,   Unknown }
	HydroCouple::DistanceUnitType are the types of units that can be used to measure distance. More...
enum class	DistanceUnits {   Meters ,   Kilometers ,   Feet ,   NauticalMiles ,   Yards ,   Miles ,   Degrees ,   Centimeters ,   Millimeters ,   Inches ,   Unknown }
	HydroCouple::DistanceUnits are the types of units that can be used to measure distance. More...
enum	AreaUnits {   SquareMeters ,   SquareKilometers ,   SquareFeet ,   SquareYards ,   SquareMiles ,   Hectares ,   Acres ,   SquareNauticalMiles ,   SquareDegrees ,   SquareCentimeters ,   SquareMillimeters ,   SquareInches ,   Unknown }
	HydroCouple::AreaUnits are the types of units that can be used to measure area. More...

Public Member Functions
virtual	~IUnit ()=default
	IUnit::~IUnit is a virtual destructor.
virtual IUnitDimensions *	dimensions () const =0
	Fundamental dimensions of the unit.
virtual double	conversionFactorToSI () const =0
	Conversion factor to SI ('A' in: SI-value = A * quant-value + B)
virtual double	offsetToSI () const =0
	OffSet to SI ('B' in: SI-value = A * quant-value + B).
Public Member Functions inherited from HydroCouple::IDescription
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

IUnit interface, describing the physical unit of a IQuantity.

Member Enumeration Documentation

AreaUnits

enum HydroCouple::IUnit::AreaUnits

HydroCouple::AreaUnits are the types of units that can be used to measure area.

Enumerator
SquareMeters	SquareMeters.
SquareKilometers	SquareKilometers.
SquareFeet	Square Feet.
SquareYards	Square Yards.
SquareMiles	Square Miles.
Hectares	Hectares.
Acres	Acres.
SquareNauticalMiles	Square Nautical Miles.
SquareDegrees	Square Degrees.
SquareCentimeters	Square Centimeters.
SquareMillimeters	Square Millimeters.
SquareInches	Square Inches.
Unknown	Unknown.

DistanceUnits

enum class HydroCouple::IUnit::DistanceUnits

strong

HydroCouple::DistanceUnits are the types of units that can be used to measure distance.

Enumerator
Meters	Meters.
Kilometers	Kilometers.
Feet	Feet.
NauticalMiles	NauticalMiles.
Yards	Yards.
Miles	Miles.
Degrees	Degrees.
Centimeters	Centimeters.
Millimeters	Millimeters.
Inches	Inches.
Unknown	Unknown.

DistanceUnitType

enum class HydroCouple::IUnit::DistanceUnitType

strong

HydroCouple::DistanceUnitType are the types of units that can be used to measure distance.

Enumerator
Standard
Geographic
Unknown

Constructor & Destructor Documentation

~IUnit()

virtual HydroCouple::IUnit::~IUnit ( )

virtualdefault

IUnit::~IUnit is a virtual destructor.

Member Function Documentation

conversionFactorToSI()

virtual double HydroCouple::IUnit::conversionFactorToSI ( ) const

pure virtual

Conversion factor to SI ('A' in: SI-value = A * quant-value + B)

dimensions()

virtual IUnitDimensions * HydroCouple::IUnit::dimensions ( ) const

pure virtual

Fundamental dimensions of the unit.

offsetToSI()

virtual double HydroCouple::IUnit::offsetToSI ( ) const

pure virtual

OffSet to SI ('B' in: SI-value = A * quant-value + B).

---

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

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