Time.h

Go to the documentation of this file.

/* Copyright (C) 2002 - 2009, 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 _Time_h
#define _Time_h

// Quantity includes
#include "Quantity/Variable.h"
#include "Quantity/Constant.h"
#include "Quantity/QuantityCluster.h"

namespace quantity {
  namespace time {

class Class;

class Unit;

/* declaration of Time units */
class SecondUnits;
class MinuteUnit;
class HourUnit;
class DayUnit;
class YearUnit;
class SvedbergUnit;
class AtomicUnit;

typedef unit::Prefixable<Unit, SecondUnits> Seconds;

typedef unit::Prefixed<Seconds> Second; 
typedef unit::Prefixed<Seconds, unit::Deci> DeciSecond;
typedef unit::Prefixed<Seconds, unit::Milli> MilliSecond;
typedef unit::Prefixed<Seconds, unit::Micro> MicroSecond;
typedef unit::Prefixed<Seconds, unit::Nano> NanoSecond;
typedef unit::Prefixed<Seconds, unit::Pico> PicoSecond;

typedef unit::NonPrefixable<Unit, MinuteUnit> Minute; 

typedef unit::NonPrefixable<Unit, HourUnit> Hour; 

typedef unit::NonPrefixable<Unit, DayUnit> Day; 

typedef unit::NonPrefixable<Unit, YearUnit> Year; 

typedef unit::NonPrefixable<Unit, SvedbergUnit> Svedberg; 

typedef unit::NonPrefixable<Unit, AtomicUnit> Atomic; 

typedef Loki::TL::Append<Seconds::Units, 
  LOKI_TYPELIST_6(Minute, Hour, Day, Year, Svedberg, Atomic)>::Result 
                                                                  Units;

/* declare some abbreviated time units */
typedef Second s;
typedef MilliSecond ms;
typedef MicroSecond us;
typedef Minute min;

/* Time Quantity */

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

class DerivedTime;

  } // end namespace time


  template<typename ST>
    struct Standard<time::Seconds, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<time::Seconds, ST>::ratio = 1.0;

template<typename ST> const bool Standard<time::Seconds, ST>::exact = true;


  template<typename ST>
    struct Standard<time::Minute, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<time::Minute, ST>::ratio = 60.0;

template<typename ST> const bool Standard<time::Minute, ST>::exact = true;


  template<typename ST>
    struct Standard<time::Hour, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<time::Hour, ST>::ratio = 3600.0;

template<typename ST> const bool Standard<time::Hour, ST>::exact = true;


  template<typename ST>
    struct Standard<time::Day, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<time::Day, ST>::ratio = 86400.0;

template<typename ST> const bool Standard<time::Day, ST>::exact = true;


  template<typename ST>
    struct Standard<time::Year, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<time::Year, ST>::ratio = 31556952.0;

template<typename ST> const bool Standard<time::Year, ST>::exact = false;


  template<typename ST>
    struct Standard<time::Svedberg, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<time::Svedberg, ST>::ratio = 1.0e-13;

template<typename ST> const bool Standard<time::Svedberg, ST>::exact = true;


  template<typename ST>
    struct Standard<time::Atomic, ST>
    {
      static const ST ratio;
      static const bool exact;
    };

template<typename ST> const ST Standard<time::Atomic, ST>::ratio = 2.4188e-17;

template<typename ST> const bool Standard<time::Atomic, ST>::exact = false;

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

    typedef time::DerivedTime DefaultDerivedQuantityType;

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

  };

// the derived quantity traits template for derived Times
template<>
  struct DerivedQuantityTraits<time::Class, time::DerivedTime>
  {
    static const bool OverwriteName = false;
    static const bool OverwriteSymbol = false;

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

  };

typedef Variable<time::Quantity> Time;

typedef Variable<time::IntQuantity> IntTime;

typedef Variable<time::LongQuantity> LongTime;

typedef Variable<time::Quantity, DerivedQuantity<time::Class, time::Minute> > MinuteTime;

typedef Constant<time::Quantity> TimeConstant;

typedef QuantityVector<Variable, time::Quantity> TimeVector;

} // end namespace quantity

#endif /* _Time_h */

---