PARTONS::UnitCategory Class Reference

Definition of units. More...

Public Types
enum	Type {   UNDEFINED = 0 , NONE = 1 , EMP = 2 , EMP2 = 3 ,   DISTANCE_TIME = 4 , CROSS_SECTION = 5 , ANGLE = 6 }
	Enum types. More...

Public Member Functions
	UnitCategory ()
	Default constructor. More...
	UnitCategory (Type type)
	Assignment constructor. More...
	UnitCategory (const UnitCategory &other)
	Copy constructor. More...
	operator Type () const
	Automatic cast to enum. More...
std::string	toString () const
	Get string representing class content. More...
std::string	getShortName ()
	Get short string representing UnitCategory::m_type. More...
void	serialize (ElemUtils::Packet &packet) const
	Serialize into given Packet. More...
void	unserialize (ElemUtils::Packet &packet)
	Retrieve data from given Packet. More...
UnitCategory::Type	getType () const
	Get UnitCategory::m_type. More...
void	setType (Type type)
	Set UnitCategory::m_type. More...

Private Attributes
UnitCategory::Type	m_type
	Type. More...

Detailed Description

Definition of units.

Member Enumeration Documentation

Type

enum PARTONS::UnitCategory::Type

Enum types.

Enumerator
UNDEFINED	Undefined.
NONE	None.
EMP	Energy, mass or momentum (eV in natural units)
EMP2	Square of energy, mass or momentum (eV^2 in natural units)
DISTANCE_TIME	Distance or time (eV^-1 in natural units)
CROSS_SECTION	Cross section (eV^-2 in natural units)
ANGLE	Angle.

Constructor & Destructor Documentation

UnitCategory() [1/3]

PARTONS::UnitCategory::UnitCategory

(

)

Default constructor.

UnitCategory() [2/3]

PARTONS::UnitCategory::UnitCategory

(

Type

type

)

Assignment constructor.

Parameters

type	Type to be assigned.

UnitCategory() [3/3]

PARTONS::UnitCategory::UnitCategory

(

const UnitCategory &

other

)

Copy constructor.

Parameters

other

Object to be copied.

Member Function Documentation

getShortName()

std::string PARTONS::UnitCategory::getShortName

(

)

Get short string representing UnitCategory::m_type.

getType()

UnitCategory::Type PARTONS::UnitCategory::getType

(

)

const

Get UnitCategory::m_type.

operator Type()

PARTONS::UnitCategory::operator UnitCategory::Type

(

)

const

Automatic cast to enum.

serialize()

void PARTONS::UnitCategory::serialize

(

ElemUtils::Packet &

packet

)

const

Serialize into given Packet.

Parameters

packet

Target Packet.

setType()

void PARTONS::UnitCategory::setType

(

Type

type

)

Set UnitCategory::m_type.

toString()

std::string PARTONS::UnitCategory::toString

(

)

const

Get string representing class content.

unserialize()

void PARTONS::UnitCategory::unserialize

(

ElemUtils::Packet &

packet

)

Retrieve data from given Packet.

Parameters

packet

Input Packet.

Member Data Documentation

m_type

UnitCategory::Type PARTONS::UnitCategory::m_type

private

Type.

---

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

• include/partons/utils/type/UnitCategory.h
• src/partons/utils/type/UnitCategory.cpp