HepMC3::Units Class Reference

Stores units-related enums and conversion functions. More...

#include <Units.h>

Public Types
enum	LengthUnit { MM , CM }
	Position units. More...
enum	MomentumUnit { MEV , GEV }
	Momentum units. More...

Static Public Member Functions
template<typename T>
static void	convert (T &m, LengthUnit from, LengthUnit to)
	Convert FourVector to different length unit.
template<typename T>
static void	convert (T &m, MomentumUnit from, MomentumUnit to)
	Convert FourVector to different momentum unit.
static LengthUnit	length_unit (const std::string &name)
	Get length unit based on its name.
static MomentumUnit	momentum_unit (const std::string &name)
	Get momentum unit based on its name.
static std::string	name (LengthUnit u)
	Get name of length unit.
static std::string	name (MomentumUnit u)
	Get name of momentum unit.

Detailed Description

Stores units-related enums and conversion functions.

Manages units used by HepMC::GenEvent

Definition at line 26 of file Units.h.

Member Enumeration Documentation

LengthUnit

enum HepMC3::Units::LengthUnit

Position units.

Definition at line 32 of file Units.h.

{ MM,  CM  };

MomentumUnit

enum HepMC3::Units::MomentumUnit

Momentum units.

Definition at line 29 of file Units.h.

{ MEV, GEV };

Member Function Documentation

convert() [1/2]

template<typename T>

static void HepMC3::Units::convert ( T & m, LengthUnit from, LengthUnit to )

inlinestatic

Convert FourVector to different length unit.

Definition at line 96 of file Units.h.

                                                                {
        if ( from == to ) return;
 
        if ( from == CM ) {
            // CM -> MM
            m *= 10.0;
        }
        else if ( from == MM ) {
            // MM -> CM
            m *= 0.1;
        }
    }

convert() [2/2]

template<typename T>

static void HepMC3::Units::convert ( T & m, MomentumUnit from, MomentumUnit to )

inlinestatic

Convert FourVector to different momentum unit.

Definition at line 81 of file Units.h.

                                                                    {
        if ( from == to ) return;
 
        if ( from == GEV ) {
            // GEV -> MEV
            m *= 1000.;
        }
        else if ( from == MEV ) {
            // MEV -> GEV
            m *= 0.001;
        }
    }

Referenced by HepMC3::GenEvent::set_units().

length_unit()

static LengthUnit HepMC3::Units::length_unit ( const std::string & name )

inlinestatic

Get length unit based on its name.

Definition at line 46 of file Units.h.

                                                           {
        if ( name.compare(0,2,"CM") == 0 ) return CM;
        if ( name.compare(0,2,"MM") == 0 ) return MM;
 
        HEPMC3_ERROR_LEVEL(300,"Units::length_unit: unrecognised unit name: '" << name <<"', setting to CM" )
 
        return CM;
    }

References name().

momentum_unit()

static MomentumUnit HepMC3::Units::momentum_unit ( const std::string & name )

inlinestatic

Get momentum unit based on its name.

Definition at line 36 of file Units.h.

                                                               {
        if ( name.compare(0,3,"GEV") == 0 ) return GEV;
        if ( name.compare(0,3,"MEV") == 0 ) return MEV;
 
        HEPMC3_ERROR_LEVEL(300,"Units::momentum_unit: unrecognised unit name: '" << name <<"', setting to GEV" )
 
        return GEV;
    }

References name().

name() [1/2]

static std::string HepMC3::Units::name ( LengthUnit u )

inlinestatic

Get name of length unit.

Definition at line 68 of file Units.h.

                                          {
        switch(u) {
        case MM:
            return "MM";
        case CM:
            return "CM";
        }
 
        return "<UNDEFINED>";
    }

name() [2/2]

static std::string HepMC3::Units::name ( MomentumUnit u )

inlinestatic

Get name of momentum unit.

Definition at line 56 of file Units.h.

                                            {
        switch(u) {
        case MEV:
            return "MEV";
        case GEV:
            return "GEV";
        }
 
        return "<UNDEFINED>";
    }

Referenced by length_unit(), HepMC3::Print::listing(), momentum_unit(), and HepMC3::WriterAscii::write_event().

---

The documentation for this class was generated from the following file:

• /home/sjg/Desktop/marley/include/builtin/HepMC3/Units.h