Frequency.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 _Frequency_h
#define _Frequency_h

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

namespace quantity {
  namespace frequency {

class Class;

class Unit;

/* declaration of Frequency units */
class HertzUnits;

typedef unit::Prefixable<Unit, HertzUnits> Hertzs;

typedef unit::Prefixed<Hertzs> Hertz;

typedef unit::Prefixed<Hertzs, unit::Milli> MilliHertz;

typedef unit::Prefixed<Hertzs, unit::Kilo> KiloHertz;

typedef unit::Prefixed<Hertzs, unit::Mega> MegaHertz;

typedef unit::Prefixed<Hertzs, unit::Giga> GigaHertz;

typedef Hertzs::Units Units;

/* declare some abbreviated time units */
typedef Hertz Hz;
typedef MilliHertz mHz;
typedef MegaHertz MHz;
typedef GigaHertz GHz;

/* Frequency Quantity */

typedef Quantity<Class> Quantity;

class DerivedFrequency;

  } // end namespace frequency


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

template<typename ST> const ST Standard<frequency::Hertzs, ST>::ratio = 1.0;

template<typename ST> const bool Standard<frequency::Hertzs, ST>::exact = true;

template<>
  struct QuantityTraits<frequency::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 frequency::Unit UnitType;
    typedef frequency::Units UnitList;
    typedef frequency::Hertz DefaultUnit;

    typedef frequency::DerivedFrequency DefaultDerivedQuantityType;

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


  };

// the derived quantity traits template for Hertz Frequency
template<>
  struct DerivedQuantityTraits<frequency::Class, frequency::DerivedFrequency>
  {
    static const bool OverwriteName = false;
    static const bool OverwriteSymbol = false;

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

  };

typedef Variable<frequency::Quantity> Frequency;

typedef Constant<frequency::Quantity> FrequencyConstant;

typedef QuantityVector<Variable, frequency::Quantity> FrequencyVector;

}

#endif /* _Frequency_h */

---