HydroCouple  2.0.0
HydroCouple Interface Definitions
HydroCouple::IUnitDimensions Class Referenceabstract

Defines the order of dimension in each FundamentalDimension for a unit. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IUnitDimensions:
Collaboration diagram for HydroCouple::IUnitDimensions:

Public Types

enum  FundamentalUnitDimension {
  Length ,
  Mass ,
  Time ,
  ElectricCurrent ,
  Temperature ,
  AmountOfSubstance ,
  LuminousIntensity ,
  Currency
}
 HydroCouple::FundamentalUnitDimension are the fundamental units that can be combined to form all types of units. More...
 

Public Member Functions

virtual ~IUnitDimensions ()=0
 IUnitDimensions::~IUnitDimensions is a virtual destructor. More...
 
virtual double getPower (HydroCouple::IUnitDimensions::FundamentalUnitDimension dimension)=0
 Returns the power for the requested dimension. 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

Defines the order of dimension in each FundamentalDimension for a unit.

Member Enumeration Documentation

◆ FundamentalUnitDimension

HydroCouple::FundamentalUnitDimension are the fundamental units that can be combined to form all types of units.

Enumerator
Length 

Fundamental dimension for length.

Mass 

Fundamental dimension for mass.

Time 

Fundamental dimension for time.

ElectricCurrent 

Fundamental dimension for electric current.

Temperature 

Fundamental dimension for temperature.

AmountOfSubstance 

Fundamental dimension for amount of substance.

LuminousIntensity 

Fundamental dimension for luminous intensity.

Currency 

Fundamental dimension for currency.

Constructor & Destructor Documentation

◆ ~IUnitDimensions()

virtual HydroCouple::IUnitDimensions::~IUnitDimensions ( )
pure virtual

IUnitDimensions::~IUnitDimensions is a virtual destructor.

Member Function Documentation

◆ getPower()

virtual double HydroCouple::IUnitDimensions::getPower ( HydroCouple::IUnitDimensions::FundamentalUnitDimension  dimension)
pure virtual

Returns the power for the requested dimension.

Parameters
dimensionrepresents the fundamental unit.

For a quantity such as flow, which may have the unit m3/s, The getPower method must work as follows:

  • getPower( FundamentalUnitDimension::AmountOfSubstance )
    Returns
    0
  • getPower( FundamentalUnitDimension::Currency )
    Returns
    0
  • getPower( FundamentalUnitDimension::ElectricCurrent )
    Returns
    0
  • getPower( FundamentalUnitDimension::Length )
    Returns
    3
  • getPower( FundamentalUnitDimension::LuminousIntensity )
    Returns
    0
  • getPower( FundamentalUnitDimension::Mass )
    Returns
    0
  • getPower( FundamentalUnitDimension::Temperature )
    Returns
    0
  • getPower( FundamentalUnitDimension::Time )
    Returns
    -1

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