Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
biogears::SEScalarQuantity< Unit > Class Template Reference

#include <SEScalarQuantity.h>

Inheritance diagram for biogears::SEScalarQuantity< Unit >:
Inheritance graph
[legend]

Public Member Functions

 SEScalarQuantity ()
 
 SEScalarQuantity (const SEScalarQuantity &)
 
 SEScalarQuantity (double, const Unit &)
 
 ~SEScalarQuantity () override
 
void Clear () override
 
void Invalidate () override
 
bool IsValid () const override
 
virtual void Load (const CDM::ScalarData &in) override
 
virtual CDM::ScalarData * Unload () const override
 
virtual bool Set (const SEScalarQuantity< Unit > &s)
 
void Copy (const SEScalarQuantity< Unit > &s)
 
void SetValue (double d, const Unit &unit)
 
virtual double GetValue (const Unit &unit) const
 
virtual double GetValue () const final
 
double GetValue (const char *unit) const override
 
double GetValue (const std::string &unit) const override
 
const Unit * GetUnit () const override
 
SEScalarQuantity & IncrementValue (double d, const char *unit) override
 
SEScalarQuantity & IncrementValue (double d, const std::string &unit) override
 
SEScalarQuantity & IncrementValue (double d, const Unit &unit)
 
SEScalarQuantity & Increment (const SEScalarQuantity &s)
 
SEScalarQuantity & DecrementValue (double d, const char *unit) override
 
SEScalarQuantity & DecrementValue (double d, const std::string &unit) override
 
SEScalarQuantity & DecrementValue (double d, const Unit &unit)
 
SEScalarQuantity & Decrement (const SEScalarQuantity &s)
 
SEScalarQuantity & MultiplyValue (double d)
 
SEScalarQuantity & Multiply (const SEScalar &s)
 
SEScalarQuantity & DivideValue (double d)
 
SEScalarQuantity & Divide (const SEScalar &s)
 
bool operator< (const SEScalarQuantity &rhs) const
 
bool operator<= (const SEScalarQuantity &rhs) const
 
bool operator> (const SEScalarQuantity &rhs) const
 
bool operator>= (const SEScalarQuantity &rhs) const
 
bool operator== (const SEScalarQuantity &rhs) const
 
bool operator!= (const SEScalarQuantity &rhs) const
 
SEScalarQuantity operator+ (const SEScalarQuantity &rhs) const
 
SEScalarQuantity & operator+= (const SEScalarQuantity &rhs)
 
SEScalarQuantity operator- (const SEScalarQuantity &rhs) const
 
SEScalarQuantity & operator-= (const SEScalarQuantity &rhs)
 
SEScalarQuantity operator/ (const SEScalar &rhs) const
 
SEScalarQuantity & operator/= (const SEScalar &rhs)
 
SEScalarQuantity operator* (const SEScalar &rhs) const
 
SEScalarQuantity & operator*= (const SEScalar &rhs)
 
virtual bool Equals (const SEScalarQuantity< Unit > &to) const
 
virtual void ToString (std::ostream &str) const override
 
const Unit * GetCompoundUnit (const char *unit) const override
 
const Unit * GetCompoundUnit (const std::string &unit) const override
 
- Public Member Functions inherited from biogears::SEUnitScalar
 SEUnitScalar ()
 
 SEUnitScalar (const SEUnitScalar &)
 
 ~SEUnitScalar () override
 
- Public Member Functions inherited from biogears::SEScalar
 SEScalar ()
 
 SEScalar (double)
 
virtual ~SEScalar ()
 
bool Set (const SEScalar &s)
 
void Copy (const SEScalar &s)
 
bool IsInfinity () const
 
bool IsPositive () const
 
bool IsNegative () const
 
bool IsZero (double limit=ZERO_APPROX) const
 
void SetReadOnly (bool b)
 
bool IsReadOnly () const
 
virtual void SetValue (double d)
 
double Increment (const SEScalar &s)
 
double IncrementValue (double d)
 
double Decrement (const SEScalar &s)
 
double DecrementValue (double d)
 
double Multiply (const SEScalar &s)
 
double MultiplyValue (double d)
 
double Divide (const SEScalar &s)
 
double DivideValue (double d)
 
bool Equals (const SEScalar &to) const
 
bool operator< (const SEScalar &rhs) const
 
bool operator<= (const SEScalar &rhs) const
 
bool operator> (const SEScalar &rhs) const
 
bool operator>= (const SEScalar &rhs) const
 
bool operator== (const SEScalar &rhs) const
 
bool operator!= (const SEScalar &rhs) const
 
SEScalar operator+ (const SEScalar &rhs) const
 
SEScalar & operator+= (const SEScalar &rhs)
 
SEScalar operator- (const SEScalar &rhs) const
 
SEScalar & operator-= (const SEScalar &rhs)
 
SEScalar operator/ (const SEScalar &rhs) const
 
SEScalar & operator/= (const SEScalar &rhs)
 
SEScalar operator* (const SEScalar &rhs) const
 
SEScalar & operator*= (const SEScalar &rhs)
 
- Public Member Functions inherited from biogears::SEProperty
 SEProperty ()
 
virtual ~SEProperty ()
 
virtual bool Load (const CDM::PropertyData &in)
 

Protected Member Functions

virtual void Unload (CDM::ScalarData &s) const override
 
- Protected Member Functions inherited from biogears::SEProperty
virtual void Unload (CDM::PropertyData &data) const
 

Protected Attributes

const Unit * m_unit
 
- Protected Attributes inherited from biogears::SEScalar
double m_value
 
bool m_readOnly
 

Additional Inherited Members

- Static Public Member Functions inherited from biogears::SEScalar
static double dNaN ()
 
static bool IsZero (double value, double limit)
 
static bool IsValue (double target, double value)
 
- Static Public Attributes inherited from biogears::SEScalar
static double NaN = std::numeric_limits<double>::quiet_NaN()
 
static const std::string unitless
 

Constructor & Destructor Documentation

template<typename Unit>
biogears::SEScalarQuantity< Unit >::SEScalarQuantity ( )
template<typename Unit>
biogears::SEScalarQuantity< Unit >::SEScalarQuantity ( const SEScalarQuantity< Unit > &  )
template<typename Unit>
biogears::SEScalarQuantity< Unit >::SEScalarQuantity ( double  ,
const Unit &   
)
explicit
template<typename Unit>
biogears::SEScalarQuantity< Unit >::~SEScalarQuantity ( )
override

Member Function Documentation

template<typename Unit>
void biogears::SEScalarQuantity< Unit >::Clear ( )
overridevirtual

Reimplemented from biogears::SEScalar.

template<typename Unit>
void biogears::SEScalarQuantity< Unit >::Copy ( const SEScalarQuantity< Unit > &  s)
template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::Decrement ( const SEScalarQuantity< Unit > &  s)
template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::DecrementValue ( double  d,
const char *  unit 
)
overridevirtual

Implements biogears::SEUnitScalar.

template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::DecrementValue ( double  d,
const std::string &  unit 
)
overridevirtual

Implements biogears::SEUnitScalar.

template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::DecrementValue ( double  d,
const Unit &  unit 
)
template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::Divide ( const SEScalar &  s)
template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::DivideValue ( double  d)
template<typename Unit>
virtual bool biogears::SEScalarQuantity< Unit >::Equals ( const SEScalarQuantity< Unit > &  to) const
virtual
template<typename Unit>
const Unit* biogears::SEScalarQuantity< Unit >::GetCompoundUnit ( const char *  unit) const
overridevirtual

Implements biogears::SEUnitScalar.

template<typename Unit>
const Unit* biogears::SEScalarQuantity< Unit >::GetCompoundUnit ( const std::string &  unit) const
overridevirtual

Implements biogears::SEUnitScalar.

template<typename Unit>
const Unit* biogears::SEScalarQuantity< Unit >::GetUnit ( ) const
overridevirtual

Implements biogears::SEUnitScalar.

template<typename Unit>
virtual double biogears::SEScalarQuantity< Unit >::GetValue ( const Unit &  unit) const
virtual

Reimplemented in biogears::SEScalarTemperature.

template<typename Unit>
virtual double biogears::SEScalarQuantity< Unit >::GetValue ( ) const
finalvirtual

Reimplemented from biogears::SEUnitScalar.

template<typename Unit>
double biogears::SEScalarQuantity< Unit >::GetValue ( const char *  unit) const
overridevirtual

Implements biogears::SEUnitScalar.

template<typename Unit>
double biogears::SEScalarQuantity< Unit >::GetValue ( const std::string &  unit) const
overridevirtual

Implements biogears::SEUnitScalar.

template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::Increment ( const SEScalarQuantity< Unit > &  s)
template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::IncrementValue ( double  d,
const char *  unit 
)
overridevirtual

Implements biogears::SEUnitScalar.

template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::IncrementValue ( double  d,
const std::string &  unit 
)
overridevirtual

Implements biogears::SEUnitScalar.

template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::IncrementValue ( double  d,
const Unit &  unit 
)
template<typename Unit>
void biogears::SEScalarQuantity< Unit >::Invalidate ( )
overridevirtual

Sets the value to NaN and removes the unit Note that this does not affect bounds

Reimplemented from biogears::SEScalar.

template<typename Unit>
bool biogears::SEScalarQuantity< Unit >::IsValid ( ) const
overridevirtual

Reimplemented from biogears::SEScalar.

template<typename Unit>
virtual void biogears::SEScalarQuantity< Unit >::Load ( const CDM::ScalarData &  in)
overridevirtual

Reimplemented from biogears::SEScalar.

template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::Multiply ( const SEScalar &  s)
template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::MultiplyValue ( double  d)
template<typename Unit>
bool biogears::SEScalarQuantity< Unit >::operator!= ( const SEScalarQuantity< Unit > &  rhs) const
template<typename Unit>
SEScalarQuantity biogears::SEScalarQuantity< Unit >::operator* ( const SEScalar &  rhs) const
template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::operator*= ( const SEScalar &  rhs)
template<typename Unit>
SEScalarQuantity biogears::SEScalarQuantity< Unit >::operator+ ( const SEScalarQuantity< Unit > &  rhs) const
template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::operator+= ( const SEScalarQuantity< Unit > &  rhs)
template<typename Unit>
SEScalarQuantity biogears::SEScalarQuantity< Unit >::operator- ( const SEScalarQuantity< Unit > &  rhs) const
template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::operator-= ( const SEScalarQuantity< Unit > &  rhs)
template<typename Unit>
SEScalarQuantity biogears::SEScalarQuantity< Unit >::operator/ ( const SEScalar &  rhs) const
template<typename Unit>
SEScalarQuantity& biogears::SEScalarQuantity< Unit >::operator/= ( const SEScalar &  rhs)
template<typename Unit>
bool biogears::SEScalarQuantity< Unit >::operator< ( const SEScalarQuantity< Unit > &  rhs) const
template<typename Unit>
bool biogears::SEScalarQuantity< Unit >::operator<= ( const SEScalarQuantity< Unit > &  rhs) const
template<typename Unit>
bool biogears::SEScalarQuantity< Unit >::operator== ( const SEScalarQuantity< Unit > &  rhs) const
template<typename Unit>
bool biogears::SEScalarQuantity< Unit >::operator> ( const SEScalarQuantity< Unit > &  rhs) const
template<typename Unit>
bool biogears::SEScalarQuantity< Unit >::operator>= ( const SEScalarQuantity< Unit > &  rhs) const
template<typename Unit>
virtual bool biogears::SEScalarQuantity< Unit >::Set ( const SEScalarQuantity< Unit > &  s)
virtual
template<typename Unit>
void biogears::SEScalarQuantity< Unit >::SetValue ( double  d,
const Unit &  unit 
)
template<typename Unit>
virtual void biogears::SEScalarQuantity< Unit >::ToString ( std::ostream &  str) const
overridevirtual

Implements biogears::SEUnitScalar.

template<typename Unit>
virtual CDM::ScalarData* biogears::SEScalarQuantity< Unit >::Unload ( ) const
overridevirtual

Reimplemented from biogears::SEScalar.

Reimplemented in TestScalarQuantity, biogears::SEScalarMassPerVolume, biogears::SEScalarMassPerAmount, biogears::SEScalarAreaPerTimePressure, biogears::SEScalarMassPerTime, biogears::SEScalarVolumePerTime, biogears::SEScalarAmountPerTime, biogears::SEScalarAmountPerVolume, biogears::SEScalarLength, biogears::SEScalarLengthPerTime, biogears::SEScalarMass, biogears::SEScalarPower, biogears::SEScalarTimeMassPerVolume, biogears::SEScalarFlowInertance, biogears::SEScalarFlowResistance, biogears::SEScalarPressure, biogears::SEScalarTime, biogears::SEScalarVolume, biogears::SEScalarVolumePerTimeMass, biogears::SEScalarEnergy, biogears::SEScalarEnergyPerMass, biogears::SEScalarFlowCompliance, biogears::SEScalarFrequency, biogears::SEScalarHeatCapacitance, biogears::SEScalarHeatCapacitancePerMass, biogears::SEScalarHeatConductance, biogears::SEScalarHeatResistance, biogears::SEScalarHeatResistanceArea, biogears::SEScalarInversePressure, biogears::SEScalarLengthPerTimePressure, biogears::SEScalarPressureTimePerVolumeArea, biogears::SEScalarTemperature, biogears::SEScalarVolumePerTimePressure, biogears::SEScalarAmount, biogears::SEScalarAmountPerMass, biogears::SEScalarFlowElastance, biogears::SEScalarForce, biogears::SEScalarHeatConductancePerArea, biogears::SEScalarVolumePerTimeArea, biogears::SEScalarElectricPotential, biogears::SEScalarEnergyPerAmount, biogears::SEScalarInverseVolume, biogears::SEScalarOsmolality, biogears::SEScalarOsmolarity, biogears::SEScalarPressurePerVolume, biogears::SEScalarPressureTimePerArea, biogears::SEScalarVolumePerPressure, biogears::SEScalarVolumePerTimePressureArea, biogears::SEScalarArea, biogears::SEScalarElectricCapacitance, biogears::SEScalarElectricCharge, biogears::SEScalarElectricCurrent, biogears::SEScalarElectricInductance, biogears::SEScalarElectricResistance, biogears::SEScalarHeatCapacitancePerAmount, biogears::SEScalarHeatInductance, biogears::SEScalarMassPerAreaTime, biogears::SEScalarMassPerMass, and biogears::SEScalarPowerPerAreaTemperatureToTheFourth.

template<typename Unit>
virtual void biogears::SEScalarQuantity< Unit >::Unload ( CDM::ScalarData &  s) const
overrideprotectedvirtual

Reimplemented from biogears::SEScalar.

Member Data Documentation

template<typename Unit>
const Unit* biogears::SEScalarQuantity< Unit >::m_unit
protected