Dedimensionalization.h

Go to the documentation of this file.

/* Copyright (C) 2006, Bernd Speiser */
/* This file is part of Quantity.

Quantity 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.

Quantity 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 _Dedimensionalization_h
#define _Dedimensionalization_h

#include "Quantity/Quantity.h"
#include "Quantity/QuantityError.h"

#include "Functor.h"
#include "HierarchyGenerators.h"

namespace quantity {

//
//  the DedimReturn class
//


template<class PQ, class SU = typename PQ::DefaultUnit::Unit> 
                                         class DefaultDedimensionalizer;


template<class PQ, class SU = typename PQ::DefaultUnit::Unit> 
                                                      class DedimReturn;


template<long RL_N, long RL_D, long RM_N, long RM_D, 
  long RT_N, long RT_D, long RE_N, long RE_D, long RTE_N, long RTE_D,
    long RA_N, long RA_D, long RLU_N, long RLU_D, 
                       class BT, class UL, class DU, class SU, class ST>
  class DedimReturn<Quantity<dimension::Dimension<
    BSUtilities::Rational<RL_N, RL_D>,
      BSUtilities::Rational<RM_N, RM_D>,  
        BSUtilities::Rational<RT_N, RT_D>,
          BSUtilities::Rational<RE_N, RE_D>,
            BSUtilities::Rational<RTE_N, RTE_D>, 
              BSUtilities::Rational<RA_N, RA_D>,
                BSUtilities::Rational<RLU_N, RLU_D> >, 
                                                    BT, UL, DU, ST>, SU>
      : public
      Quantity<dimension::Dimension<BSUtilities::Rational<RL_N, RL_D>,
        BSUtilities::Rational<RM_N, RM_D>,  
          BSUtilities::Rational<RT_N, RT_D>,
            BSUtilities::Rational<RE_N, RE_D>,
              BSUtilities::Rational<RTE_N, RTE_D>, 
                BSUtilities::Rational<RA_N, RA_D>,
                  BSUtilities::Rational<RLU_N, RLU_D> >, BT, UL, DU, ST>
  {
    private:

        ST _value;

    public:
      DedimReturn (void) : _value (ST(0)) {}

      DedimReturn (const ST &value) : _value (value) {}


        const std::string unitsymbol (void) const
                                                 {return SU::Symbol ();}


        const std::string unitname (void) const {return SU::Name ();}


        ST value (void) const {return _value;}


        ST standard_value (void) const
                             {return Standardize<SU, ST>::VAL (_value);}


      std::ostream & print_value (std::ostream &os) const
                          {return os << _value << " " << SU::Symbol ();}


      void operator>> (std::string &str) const
        {str 
             = BSUtilities::Conversion<DedimReturn>::to_string (*this);}


      std::ostream & operator>> (std::ostream &os) const
                                              {return this->print (os);}


    void save (BSUtilities::xmlw::XmlStream &os) const 
    {
      os << BSUtilities::xmlw::tag (Quantities::TAG)
         << BSUtilities::xmlw::attr (Quantities::MODETAG) << MODE 
// to be added ...
      << BSUtilities::xmlw::endtag (Quantities::TAG);
    }


    void load (const TiXmlHandle node) const
    {
        TiXmlElement *element = node.Element();

        if (element
          && (element->ValueStr () == Quantities::TAG)
            && (element->Attribute (Quantities::MODETAG) == MODE))
        {
// to be added ...
        }
        else
          throw LoadError
              ("error loading DedimReturn quantity: incorrect element");
    }


//    PQ (???) * create (void) {return new DedimReturn;}
// to be implemented


      static const std::string MODE;

  };

template<long RL_N, long RL_D, long RM_N, long RM_D, 
  long RT_N, long RT_D, long RE_N, long RE_D, long RTE_N, long RTE_D,
    long RA_N, long RA_D, long RLU_N, long RLU_D, 
                       class BT, class UL, class DU, class SU, class ST>
  const std::string DedimReturn<Quantity<dimension::Dimension<
    BSUtilities::Rational<RL_N, RL_D>,
      BSUtilities::Rational<RM_N, RM_D>,  
        BSUtilities::Rational<RT_N, RT_D>,
          BSUtilities::Rational<RE_N, RE_D>,
            BSUtilities::Rational<RTE_N, RTE_D>, 
              BSUtilities::Rational<RA_N, RA_D>,
                BSUtilities::Rational<RLU_N, RLU_D> >, 
                             BT, UL, DU, ST>, SU>::MODE = "DedimReturn";


template<long RL_N, long RL_D, long RM_N, long RM_D, 
  long RT_N, long RT_D, long RE_N, long RE_D, long RTE_N, long RTE_D,
    long RA_N, long RA_D, long RLU_N, long RLU_D,  
                       class BT, class UL, class DU, class SU, class ST>
  class DefaultDedimensionalizer<Quantity<dimension::Dimension<
    BSUtilities::Rational<RL_N, RL_D>,
      BSUtilities::Rational<RM_N, RM_D>,  
        BSUtilities::Rational<RT_N, RT_D>,
          BSUtilities::Rational<RE_N, RE_D>,
            BSUtilities::Rational<RTE_N, RTE_D>, 
              BSUtilities::Rational<RA_N, RA_D>,
                BSUtilities::Rational<RLU_N, RLU_D> >, 
                                                    BT, UL, DU, ST>, SU>
    {
      private:
        typedef Quantity<dimension::Dimension<
          BSUtilities::Rational<RL_N, RL_D>,
            BSUtilities::Rational<RM_N, RM_D>,  
              BSUtilities::Rational<RT_N, RT_D>,
                BSUtilities::Rational<RE_N, RE_D>,
                  BSUtilities::Rational<RTE_N, RTE_D>, 
                    BSUtilities::Rational<RA_N, RA_D>,
                      BSUtilities::Rational<RLU_N, RLU_D> >, 
                                                     BT, UL, DU, ST> PQ;


      public: 
        typedef Loki::Functor<DedimReturn<PQ, SU>,  
          LOKI_TYPELIST_1(Loki::Tuple<LOKI_TYPELIST_1
                                                 (Loki::EmptyType)>)> F;
    };

}

#endif /* _Dedimensionalization_h */

---