PoPI::PhysicalQuantity Class Reference

#include <PoPI.hpp>

Inheritance diagram for PoPI::PhysicalQuantity:

Public Member Functions
	PhysicalQuantity (HAPI::Node const &a_node, PQ_class a_class)
virtual	~PhysicalQuantity ()
PQ_class	Class (void) const
std::string const &	tag (void) const
std::string const &	label (void) const
std::string const &	valueString (void) const
std::string const &	unit (void) const
void	toXMLList (std::vector< std::string > &a_XMLList, std::string const &a_indent1) const
virtual std::string	valueToString (void) const =0

Detailed Description

The base class for all PhysicalQuantity classes.

Definition at line 403 of file PoPI.hpp.

Constructor & Destructor Documentation

PhysicalQuantity()

PoPI::PhysicalQuantity::PhysicalQuantity	(	HAPI::Node const &	a_node,
		PQ_class	a_class )

Parameters

a_node	[in] The HAPI::Node node to be parsed.
a_class	[in] The class of the physical quantity.

Definition at line 30 of file PoPI_physicalQuantity.cc.

                                                                             :
        m_class( a_class ),
        m_tag( a_node.name( ) ),
        m_label( a_node.attribute( PoPI_labelChars ).value( ) ),
        m_valueString( a_node.attribute( PoPI_valueChars ).value( ) ),
        m_unit( a_node.attribute( PoPI_unitChars ).value( ) ) {
 
}

Referenced by PoPI::PQ_double::PQ_double(), PoPI::PQ_double::PQ_double(), PoPI::PQ_fraction::PQ_fraction(), PoPI::PQ_integer::PQ_integer(), and PoPI::PQ_string::PQ_string().

~PhysicalQuantity()

PoPI::PhysicalQuantity::~PhysicalQuantity ( )

virtual

Definition at line 42 of file PoPI_physicalQuantity.cc.

                                     {
 
}

Member Function Documentation

Class()

PQ_class PoPI::PhysicalQuantity::Class ( void ) const

inline

Returns the value of the m_class member.

Definition at line 416 of file PoPI.hpp.

Referenced by PoPI::getPhysicalQuantityAsDouble().

label()

std::string const & PoPI::PhysicalQuantity::label ( void ) const

inline

Returns the value of the m_label member.

Definition at line 418 of file PoPI.hpp.

tag()

std::string const & PoPI::PhysicalQuantity::tag ( void ) const

inline

Returns the value of the m_tag member.

Definition at line 417 of file PoPI.hpp.

toXMLList()

void PoPI::PhysicalQuantity::toXMLList	(	std::vector< std::string > &	a_XMLList,
		std::string const &	a_indent1 ) const

Adds the contents of this to a_XMLList where each item in a_XMLList is one line (without linefeeds) to output as an XML representation of this.

Parameters

a_XMLList	[in] The list to add an XML output representation of this to.
a_indent1	[in] The amount of indentation to added to each line added to a_XMLList.

Definition at line 53 of file PoPI_physicalQuantity.cc.

                                                                                                    {
 
    std::string _unit;
 
    if( m_unit.size( ) > 0 ) _unit = "\" unit=\"" + m_unit;
 
    std::string header = a_indent1 + "<" + m_tag + " label=\"" + m_label + "\" value=\"" + valueToString( ) + _unit + "\"/>";
    a_XMLList.push_back( std::move( header ) );
}

unit()

std::string const & PoPI::PhysicalQuantity::unit ( void ) const

inline

Returns the value of the m_unit member.

Definition at line 420 of file PoPI.hpp.

Referenced by PoPI::Nucleus::energy().

valueString()

std::string const & PoPI::PhysicalQuantity::valueString ( void ) const

inline

Returns the value of the valueString member.

Definition at line 419 of file PoPI.hpp.

Referenced by PoPI::PQ_string::value(), PoPI::PQ_fraction::valueToString(), and PoPI::PQ_string::valueToString().

valueToString()

virtual std::string PoPI::PhysicalQuantity::valueToString ( void ) const

pure virtual

Implemented in PoPI::PQ_double, PoPI::PQ_fraction, PoPI::PQ_integer, and PoPI::PQ_string.

Referenced by toXMLList().

---

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

• PoPI.hpp
• PoPI_physicalQuantity.cc