Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | Related Pages

Units::Composed< Compound< GT, CUL, ST >, Loki::Typelist< U, UTail > > Class Template Reference

A unit which is composed of other units. More...

#include <Unit.h>

List of all members.

Public Member Functions

bool is_SI (void) const
 whether the unit is an SI unit;

bool is_exact (void) const
 whether the unit conversion is defined exactly,

ST standard (const ST &value) const
 convert value in Compound into the standard unit

ST reverse (const ST &value) const
 convert value in the standard unit into Compound

const std::string name (void) const
 return the name of this unit.

const std::string symbol (void) const
 return the symbol of this unit.


Static Public Member Functions

bool Is_SI (void)
 report whether the unit is an SI unit.

bool Is_exact (void)
 report whether the unit is defined exactly.

ST standardRatio (void)
 determine the ratio between units for standardization

ST Standard (const ST value)
 convert value in Compound into the standard unit

ST Reverse (const ST value)
 convert value in the standard unit into Compound

std::string Name (void)
 the name of this unit.

std::string Symbol (void)
 the symbol of this unit;


Private Types

typedef Loki::Typelist< U,
UTail > 
List
typedef Composed< Compound<
GT, CUL, ST >, List > 
Unit
typedef Compound< GT, CUL,
ST > 
Comp


Detailed Description

template<class GT, class U, class UTail, class CUL, class ST>
class Units::Composed< Compound< GT, CUL, ST >, Loki::Typelist< U, UTail > >

A unit which is composed of other units.

Template parameter GT is defined as for Unit; Composed is derived from a base class Compound, which ties together several Composed units for the same combination of GT and CUL; composition may be from any number of NonPrefixable, Prefixed or Composed units; the storage type ST determines the parameter and return type for the standard and reverse functions.

Definition at line 904 of file Unit.h.


Member Function Documentation

template<class GT, class U, class UTail, class CUL, class ST>
bool Units::Composed< Compound< GT, CUL, ST >, Loki::Typelist< U, UTail > >::is_exact void   )  const [inline]
 

whether the unit conversion is defined exactly,

dynamic access.

Definition at line 933 of file Unit.h.

template<class GT, class U, class UTail, class CUL, class ST>
bool Units::Composed< Compound< GT, CUL, ST >, Loki::Typelist< U, UTail > >::Is_exact void   )  [inline, static]
 

report whether the unit is defined exactly.

static access

Definition at line 927 of file Unit.h.

template<class GT, class U, class UTail, class CUL, class ST>
bool Units::Composed< Compound< GT, CUL, ST >, Loki::Typelist< U, UTail > >::is_SI void   )  const [inline]
 

whether the unit is an SI unit;

dynamic access.

Definition at line 922 of file Unit.h.

template<class GT, class U, class UTail, class CUL, class ST>
const std::string Units::Composed< Compound< GT, CUL, ST >, Loki::Typelist< U, UTail > >::name void   )  const [inline]
 

return the name of this unit.

dynamic access, to be used polymorphically if exact type is not known at compile time

Definition at line 980 of file Unit.h.

template<class GT, class U, class UTail, class CUL, class ST>
ST Units::Composed< Compound< GT, CUL, ST >, Loki::Typelist< U, UTail > >::standard const ST &  value  )  const [inline]
 

convert value in Compound into the standard unit

dynamic access.

Definition at line 952 of file Unit.h.

template<class GT, class U, class UTail, class CUL, class ST>
ST Units::Composed< Compound< GT, CUL, ST >, Loki::Typelist< U, UTail > >::Standard const ST  value  )  [inline, static]
 

convert value in Compound into the standard unit

static access.

Definition at line 946 of file Unit.h.

template<class GT, class U, class UTail, class CUL, class ST>
ST Units::Composed< Compound< GT, CUL, ST >, Loki::Typelist< U, UTail > >::standardRatio void   )  [inline, static]
 

determine the ratio between units for standardization

defines the extent of the current unit with respect to the standard unit; dynamic access.

Definition at line 939 of file Unit.h.

template<class GT, class U, class UTail, class CUL, class ST>
const std::string Units::Composed< Compound< GT, CUL, ST >, Loki::Typelist< U, UTail > >::symbol void   )  const [inline]
 

return the symbol of this unit.

dynamic access, to be used polymorphically if exact type is not known at compile time

Definition at line 997 of file Unit.h.


The documentation for this class was generated from the following file:
Generated on Sun Jan 15 13:58:01 2006 for Quantity by doxygen 1.3.6