Length.h

Go to the documentation of this file.

/* Copyright (C) 2002 - 2011, Bernd Speiser */

/* This file is part of Quantities.

PhysicalQuantities is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

PhysicalQuantities is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
  
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.
*/

#ifndef _Length_h
#define _Length_h

// Quantity includes
#include "Quantities/Quantity/Variable.h"
#include "Quantities/Quantity/Constant.h"
#include "Quantities/Quantity/QuantityAggregates.h"

namespace quantity {
  namespace length {

class Class;

class Unit;

/* declaration of Length units */
class MetreUnits;
class BohrUnit;
class AngstromUnit;
class MicronUnit;
class MilliMicronUnit;
class XUnit;
class FermiUnit;
class InchUnit;
class FootUnit;
class YardUnit;
class MileUnit;
class NauticalMileUnit;
class AstronomicalUnit;
class ParsecUnit;
class LightYearUnit;
class LightSecondUnit;

typedef unit::Prefixable<Unit, MetreUnits> Metres;

typedef unit::Prefixed<Metres> Metre;
typedef unit::Prefixed<Metres, unit::Deci> DeciMetre;
typedef unit::Prefixed<Metres, unit::Centi> CentiMetre;
typedef unit::Prefixed<Metres, unit::Milli> MilliMetre;
typedef unit::Prefixed<Metres, unit::Micro> MicroMetre;
typedef unit::Prefixed<Metres, unit::Nano> NanoMetre;
typedef unit::Prefixed<Metres, unit::Pico> PicoMetre;
typedef unit::Prefixed<Metres, unit::Kilo> KiloMetre;

typedef unit::NonPrefixable<Unit, BohrUnit> Bohr;

typedef unit::NonPrefixable<Unit, AngstromUnit> Angstrom;

typedef unit::NonPrefixable<Unit, MicronUnit> Micron;

typedef unit::NonPrefixable<Unit, MilliMicronUnit> MilliMicron;

typedef unit::NonPrefixable<Unit, XUnit> X;

typedef unit::NonPrefixable<Unit, FermiUnit> Fermi;

typedef unit::NonPrefixable<Unit, InchUnit> Inch;

typedef unit::NonPrefixable<Unit, FootUnit> Foot;

typedef unit::NonPrefixable<Unit, YardUnit> Yard;

typedef unit::NonPrefixable<Unit, MileUnit> Mile;

typedef unit::NonPrefixable<Unit, NauticalMileUnit> NauticalMile;

typedef unit::NonPrefixable<Unit, AstronomicalUnit> Astronomical;

typedef unit::NonPrefixable<Unit, ParsecUnit> Parsec;

typedef unit::NonPrefixable<Unit, LightYearUnit> LightYear;

typedef unit::NonPrefixable<Unit, LightSecondUnit> LightSecond;

typedef Loki::Typelist<Metres, Loki::Typelist<Bohr, Loki::Typelist<Angstrom, 
  Loki::Typelist<Micron, Loki::Typelist<MilliMicron, Loki::Typelist<X, 
    Loki::Typelist<Fermi, Loki::Typelist<Inch, Loki::Typelist<Foot, 
      Loki::Typelist<Yard, Loki::Typelist<Mile, Loki::Typelist<NauticalMile, 
        Loki::Typelist<Astronomical, Loki::Typelist<Parsec, 
          Loki::Typelist<LightYear, Loki::Typelist<LightSecond, 
            Loki::NullType> > > > > > > > > > > > > > > > Units;

/* declare some abbreviated length units */

typedef Metre m;
typedef MilliMetre mm;
typedef KiloMetre km;
typedef CentiMetre cm;

/* Length quantity */

typedef Quantity<Class> Quantity;
typedef quantity::Quantity<Class, int> IntQuantity;

class DerivedLength;

  } // end namespace length

template<>
  struct QuantityTraits<length::Class>
  {
    typedef
      dimension::Dimension<BSUtilities::Rational<1>,
        BSUtilities::Rational<0>, BSUtilities::Rational<0>,
          BSUtilities::Rational<0>, BSUtilities::Rational<0>,
            BSUtilities::Rational<0>, BSUtilities::Rational<0> > Dimension;
    typedef length::Unit UnitType;
    typedef length::Units UnitList;
    typedef length::Metre DefaultUnit;

    typedef length::DerivedLength DefaultDerivedQuantityType;

    static const std::string NameString ();
    static const std::string SymbolString ();

  };

// the derived quantity traits template for Metre Length
template<>
  struct DerivedQuantityTraits<length::Class, length::DerivedLength>
  {
    static const bool OverwriteName = false;
    static const bool OverwriteSymbol = false;

    static const std::string NameString ();
    static const std::string SymbolString ();

  };

typedef Variable<length::Quantity> Length;

typedef Variable<length::IntQuantity> IntLength;

typedef Constant<length::Quantity> LengthConstant;

typedef VariableVector<QuantityVector<length::Class> > LengthVector;

}

#endif /* _Length_h */

---