Area.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 _Area_h
#define _Area_h

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

namespace quantity {
  namespace area {

class Class;

class Unit;

/* declaration of Area units */
class BarnUnit;
class AcreUnit;
class AreUnit;
class HectareUnit;

typedef unit::Component<length::Units, 
                               BSUtilities::Rational<2> > LengthComponent;

typedef unit::ComposeBase<Unit, Loki::Typelist<LengthComponent, 
                                       Loki::NullType> > SquareMetreUnit;

typedef 
  unit::Composed<SquareMetreUnit, Loki::Typelist<length::Metre, 
                                           Loki::NullType> > SquareMetre;

typedef
  unit::Composed<SquareMetreUnit, Loki::Typelist<length::CentiMetre, 
                                      Loki::NullType> > SquareCentiMetre;

typedef unit::Composed<SquareMetreUnit, Loki::Typelist<length::MilliMetre, 
                                      Loki::NullType> > SquareMilliMetre;

typedef unit::NonPrefixable<Unit, BarnUnit> Barn;

typedef unit::NonPrefixable<Unit, AcreUnit> Acre;

typedef unit::NonPrefixable<Unit, AreUnit> Are;

typedef unit::NonPrefixable<Unit, HectareUnit> Hectare;

typedef Loki::Typelist<SquareMetreUnit, Loki::Typelist<Barn, 
  Loki::Typelist<Acre, Loki::Typelist<Are, Loki::Typelist<Hectare, 
                                           Loki::NullType> > > > > Units;

/* Area quantity */

typedef Quantity<Class> Quantity;

class DerivedArea;

  } // end namespace area

template<>
  struct QuantityTraits<area::Class>
  {
    typedef
      dimension::Dimension<BSUtilities::Rational<2>,
        BSUtilities::Rational<0>, BSUtilities::Rational<0>,
          BSUtilities::Rational<0>, BSUtilities::Rational<0>,
            BSUtilities::Rational<0>, BSUtilities::Rational<0> > Dimension;
    typedef area::Unit UnitType;
    typedef area::Units UnitList;
    typedef area::SquareMetre DefaultUnit;

    typedef area::DerivedArea DefaultDerivedQuantityType;

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

// the derived quantity traits template for derived Areas
template<>
  struct DerivedQuantityTraits<area::Class, area::DerivedArea>
  {
    static const bool OverwriteName = false;
    static const bool OverwriteSymbol = false;

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

  };


typedef Variable<area::Quantity> Area;

typedef Constant<area::Quantity> AreaConstant;

typedef VariableVector<QuantityVector<area::Class> > AreaVector;

} // end namespace quantity

#endif /* _Area_h */

---