lar_content::MvaTypes::InitializedDouble Class Reference

InitializedDouble class used to define mva features. More...

#include <LArMvaInterface.h>

Public Member Functions
	InitializedDouble ()
	Default constructor. More...
	InitializedDouble (const double number)
	Constructor. More...
	InitializedDouble (const InitializedDouble &rhs)
	Copy constructor. More...
InitializedDouble &	operator= (const double number)
	Assignment operator. More...
InitializedDouble &	operator= (const InitializedDouble rhs)
	Assignment operator. More...
double	Get () const
	Get number held in class. More...
bool	IsInitialized () const
	Check number has been initialized. More...

Private Attributes
double	m_number
	Number held by class. More...
bool	m_isInitialized
	Whether the number has been initialized. More...

Detailed Description

InitializedDouble class used to define mva features.

Definition at line 27 of file LArMvaInterface.h.

Constructor & Destructor Documentation

lar_content::MvaTypes::InitializedDouble::InitializedDouble ( )

inline

Default constructor.

Definition at line 130 of file LArMvaInterface.h.

                                                    : m_number(0.), m_isInitialized(false)
{
}

lar_content::MvaTypes::InitializedDouble::InitializedDouble ( const double  number )

inline

Constructor.

Parameters

number

to hold in class

Definition at line 136 of file LArMvaInterface.h.

                                                                       : m_number(number), m_isInitialized(true)
{
}

lar_content::MvaTypes::InitializedDouble::InitializedDouble ( const InitializedDouble &  rhs )

inline

Copy constructor.

Parameters

rhs	the initialized double to copy

Definition at line 142 of file LArMvaInterface.h.

                                                                                :
    m_number(rhs.m_number),
    m_isInitialized(rhs.m_isInitialized)
{
}

Member Function Documentation

double lar_content::MvaTypes::InitializedDouble::Get ( void  ) const

inline

Get number held in class.

Returns

number held in class

Definition at line 173 of file LArMvaInterface.h.

{
    if (!m_isInitialized)
        throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);

    return m_number;
}

bool lar_content::MvaTypes::InitializedDouble::IsInitialized ( ) const

inline

Check number has been initialized.

Returns

whether number has been initialized

Definition at line 183 of file LArMvaInterface.h.

{
    return m_isInitialized;
}

MvaTypes::InitializedDouble & lar_content::MvaTypes::InitializedDouble::operator= ( const double  number )

inline

Assignment operator.

Parameters

number

the double to assign

Definition at line 150 of file LArMvaInterface.h.

{
    m_number = number;
    m_isInitialized = true;

    return *this;
}

MvaTypes::InitializedDouble & lar_content::MvaTypes::InitializedDouble::operator= ( const InitializedDouble  rhs )

inline

Assignment operator.

Parameters

rhs	the initialized double to assign

Definition at line 160 of file LArMvaInterface.h.

{
    if (this != &rhs)
    {
        m_number = rhs.m_number;
        m_isInitialized = rhs.m_isInitialized;
    }

    return *this;
}

Member Data Documentation

bool lar_content::MvaTypes::InitializedDouble::m_isInitialized

private

Whether the number has been initialized.

Definition at line 79 of file LArMvaInterface.h.

double lar_content::MvaTypes::InitializedDouble::m_number

private

Number held by class.

Definition at line 78 of file LArMvaInterface.h.

---

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

• larpandoracontent/larpandoracontent/LArObjects/LArMvaInterface.h