SEScalarQuantity< Unit > Class Template Reference

#include <SEScalar.h>

Inherits SEUnitScalar.

Public Member Functions

 SEScalarQuantity ()
 
virtual ~SEScalarQuantity ()
 
virtual void Clear ()
 
virtual void Invalidate ()
 
virtual bool IsValid () const
 
virtual bool Set (const SEScalarQuantity< Unit > &s)
 
virtual void Copy (const SEScalarQuantity< Unit > &s)
 
virtual bool HasUnit () const
 
virtual const Unit * GetUnit () const
 
double GetValue () const =delete
 
virtual double GetValue (const Unit &unit) const
 
void SetValue (double d)=delete
 
virtual void SetValue (double d, const Unit &unit)
 
void ForceValue (double d)=delete
 
virtual void ForceValue (double d, const Unit &unit)
 
double IncrementValue (double d)=delete
 
virtual double IncrementValue (double d, const Unit &unit)
 
double Increment (const SEScalar &s)=delete
 
virtual double Increment (const SEScalarQuantity &s)
 
bool Equals (const SEScalar &to) const =delete
 
virtual bool Equals (const SEScalarQuantity< Unit > &to) const
 
virtual void ToString (std::ostream &str) const
 
- Public Member Functions inherited from SEUnitScalar
 SEUnitScalar ()
 
virtual ~SEUnitScalar ()
 
- Public Member Functions inherited from SEScalar
 SEScalar ()
 
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
 
double GetValue () const
 
void SetValue (double d)
 
void ForceValue (double d)
 
double Increment (const SEScalar &s)
 
double IncrementValue (double d)
 
void Average (int cnt)
 
bool Equals (const SEScalar &to) const
 
- Public Member Functions inherited from SEProperty
 SEProperty ()
 
virtual ~SEProperty ()
 

Protected Member Functions

bool Set (const SEScalar &s)
 
void Copy (const SEScalar &s)
 
virtual double GetValue (const CCompoundUnit &unit) const
 
virtual void SetValue (double d, const CCompoundUnit &unit)
 
virtual void ForceValue (double d, const CCompoundUnit &unit)
 
virtual double IncrementValue (double d, const CCompoundUnit &unit)
 
virtual const CCompoundUnitGetCompoundUnit (const std::string &unit) const
 

Protected Attributes

const Unit * m_unit
 
- Protected Attributes inherited from SEScalar
double m_value
 
bool m_isnan
 
bool m_isinf
 
bool m_readOnly
 

Friends

class PBProperty
 

Additional Inherited Members

- Static Public Member Functions inherited from SEScalar
static double dNaN ()
 
static bool IsZero (double value, double limit)
 
static bool IsValue (double target, double value)
 
- Static Public Attributes inherited from SEScalar
static unsigned long long int NaN
 

Constructor & Destructor Documentation

◆ SEScalarQuantity()

template<typename Unit>
SEScalarQuantity< Unit >::SEScalarQuantity ( )

◆ ~SEScalarQuantity()

template<typename Unit>
virtual SEScalarQuantity< Unit >::~SEScalarQuantity ( )
virtual

Member Function Documentation

◆ Clear()

template<typename Unit>
virtual void SEScalarQuantity< Unit >::Clear ( )
virtual

Reimplemented from SEScalar.

◆ Copy() [1/2]

template<typename Unit>
void SEScalarQuantity< Unit >::Copy ( const SEScalar s)
protectedvirtual

Implements SEUnitScalar.

◆ Copy() [2/2]

template<typename Unit>
virtual void SEScalarQuantity< Unit >::Copy ( const SEScalarQuantity< Unit > &  s)
virtual

◆ Equals() [1/2]

template<typename Unit>
bool SEScalarQuantity< Unit >::Equals ( const SEScalar to) const
delete

◆ Equals() [2/2]

template<typename Unit>
virtual bool SEScalarQuantity< Unit >::Equals ( const SEScalarQuantity< Unit > &  to) const
virtual

◆ ForceValue() [1/3]

template<typename Unit>
virtual void SEScalarQuantity< Unit >::ForceValue ( double  d,
const CCompoundUnit unit 
)
protectedvirtual

Implements SEUnitScalar.

◆ ForceValue() [2/3]

template<typename Unit>
void SEScalarQuantity< Unit >::ForceValue ( double  d)
delete

◆ ForceValue() [3/3]

template<typename Unit>
virtual void SEScalarQuantity< Unit >::ForceValue ( double  d,
const Unit &  unit 
)
virtual

◆ GetCompoundUnit()

template<typename Unit>
virtual const CCompoundUnit* SEScalarQuantity< Unit >::GetCompoundUnit ( const std::string &  unit) const
protectedvirtual

Implements SEUnitScalar.

◆ GetUnit()

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

Implements SEUnitScalar.

◆ GetValue() [1/3]

template<typename Unit>
virtual double SEScalarQuantity< Unit >::GetValue ( const CCompoundUnit unit) const
protectedvirtual

Implements SEUnitScalar.

◆ GetValue() [2/3]

template<typename Unit>
double SEScalarQuantity< Unit >::GetValue ( ) const
delete

◆ GetValue() [3/3]

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

Reimplemented in SEScalarTemperature.

◆ HasUnit()

template<typename Unit>
virtual bool SEScalarQuantity< Unit >::HasUnit ( ) const
virtual

Implements SEUnitScalar.

◆ Increment() [1/2]

template<typename Unit>
double SEScalarQuantity< Unit >::Increment ( const SEScalar s)
delete

◆ Increment() [2/2]

template<typename Unit>
virtual double SEScalarQuantity< Unit >::Increment ( const SEScalarQuantity< Unit > &  s)
virtual

◆ IncrementValue() [1/3]

template<typename Unit>
virtual double SEScalarQuantity< Unit >::IncrementValue ( double  d,
const CCompoundUnit unit 
)
protectedvirtual

Implements SEUnitScalar.

◆ IncrementValue() [2/3]

template<typename Unit>
double SEScalarQuantity< Unit >::IncrementValue ( double  d)
delete

◆ IncrementValue() [3/3]

template<typename Unit>
virtual double SEScalarQuantity< Unit >::IncrementValue ( double  d,
const Unit &  unit 
)
virtual

◆ Invalidate()

template<typename Unit>
virtual void SEScalarQuantity< Unit >::Invalidate ( )
virtual

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

Implements SEUnitScalar.

◆ IsValid()

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

Implements SEUnitScalar.

◆ Set() [1/2]

template<typename Unit>
bool SEScalarQuantity< Unit >::Set ( const SEScalar s)
protectedvirtual

Implements SEUnitScalar.

◆ Set() [2/2]

template<typename Unit>
virtual bool SEScalarQuantity< Unit >::Set ( const SEScalarQuantity< Unit > &  s)
virtual

◆ SetValue() [1/3]

template<typename Unit>
virtual void SEScalarQuantity< Unit >::SetValue ( double  d,
const CCompoundUnit unit 
)
protectedvirtual

Implements SEUnitScalar.

◆ SetValue() [2/3]

template<typename Unit>
void SEScalarQuantity< Unit >::SetValue ( double  d)
delete

◆ SetValue() [3/3]

template<typename Unit>
virtual void SEScalarQuantity< Unit >::SetValue ( double  d,
const Unit &  unit 
)
virtual

◆ ToString()

template<typename Unit>
virtual void SEScalarQuantity< Unit >::ToString ( std::ostream &  str) const
virtual

Reimplemented from SEScalar.

Friends And Related Function Documentation

◆ PBProperty

template<typename Unit>
friend class PBProperty
friend

Member Data Documentation

◆ m_unit

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