lar_content::LArMCParticleFactory Class Reference

LArMCParticleFactory responsible for object creation. More...

#include <LArMCParticle.h>

Inheritance diagram for lar_content::LArMCParticleFactory:

Public Member Functions
	LArMCParticleFactory (const unsigned int version=2)
	Constructor. More...
Parameters *	NewParameters () const
	Create new parameters instance on the heap (memory-management to be controlled by user) More...
pandora::StatusCode	Read (Parameters &parameters, pandora::FileReader &fileReader) const
	Read any additional (derived class only) object parameters from file using the specified file reader. More...
pandora::StatusCode	Write (const Object *const pObject, pandora::FileWriter &fileWriter) const
	Persist any additional (derived class only) object parameters using the specified file writer. More...
pandora::StatusCode	Create (const Parameters &parameters, const Object *&pObject) const
	Create an object with the given parameters. More...

Private Attributes
unsigned int	m_version
	The LArMCParticle version. More...

Detailed Description

LArMCParticleFactory responsible for object creation.

Definition at line 135 of file LArMCParticle.h.

Constructor & Destructor Documentation

lar_content::LArMCParticleFactory::LArMCParticleFactory ( const unsigned int  version = 2 )

inline

Constructor.

Parameters

version

the LArMCParticle version

Definition at line 223 of file LArMCParticle.h.

                                                                            : m_version(version)
{
}

Member Function Documentation

pandora::StatusCode lar_content::LArMCParticleFactory::Create ( const Parameters &  parameters, const Object *&  pObject  ) const

inline

Create an object with the given parameters.

Parameters

parameters	the parameters to pass in constructor
pObject	to receive the address of the object created

Definition at line 236 of file LArMCParticle.h.

{
    const LArMCParticleParameters &larMCParticleParameters(dynamic_cast<const LArMCParticleParameters &>(parameters));
    pObject = new LArMCParticle(larMCParticleParameters);

    return pandora::STATUS_CODE_SUCCESS;
}

LArMCParticleFactory::Parameters * lar_content::LArMCParticleFactory::NewParameters ( ) const

inline

Create new parameters instance on the heap (memory-management to be controlled by user)

Returns

the address of the new parameters instance

Definition at line 229 of file LArMCParticle.h.

{
    return (new LArMCParticleParameters);
}

pandora::StatusCode lar_content::LArMCParticleFactory::Read ( Parameters &  parameters, pandora::FileReader &  fileReader  ) const

inline

Read any additional (derived class only) object parameters from file using the specified file reader.

Parameters

parameters	the parameters to pass in constructor
fileReader	the file reader, used to extract any additional parameters from file

Definition at line 246 of file LArMCParticle.h.

{
    // ATTN: To receive this call-back must have already set file reader mc particle factory to this factory
    int nuanceCode(0);
    int process(0);

    if (pandora::BINARY == fileReader.GetFileType())
    {
        pandora::BinaryFileReader &binaryFileReader(dynamic_cast<pandora::BinaryFileReader &>(fileReader));
        PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, binaryFileReader.ReadVariable(nuanceCode));

        if (m_version > 1)
            PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, binaryFileReader.ReadVariable(process));
    }
    else if (pandora::XML == fileReader.GetFileType())
    {
        pandora::XmlFileReader &xmlFileReader(dynamic_cast<pandora::XmlFileReader &>(fileReader));
        PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, xmlFileReader.ReadVariable("NuanceCode", nuanceCode));

        if (m_version > 1)
            PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, xmlFileReader.ReadVariable("Process", process));
    }
    else
    {
        return pandora::STATUS_CODE_INVALID_PARAMETER;
    }

    LArMCParticleParameters &larMCParticleParameters(dynamic_cast<LArMCParticleParameters &>(parameters));
    larMCParticleParameters.m_nuanceCode = nuanceCode;
    larMCParticleParameters.m_process = process;

    return pandora::STATUS_CODE_SUCCESS;
}

pandora::StatusCode lar_content::LArMCParticleFactory::Write ( const Object *const  pObject, pandora::FileWriter &  fileWriter  ) const

inline

Persist any additional (derived class only) object parameters using the specified file writer.

Parameters

pObject	the address of the object to persist
fileWriter	the file writer

Definition at line 282 of file LArMCParticle.h.

{
    // ATTN: To receive this call-back must have already set file writer mc particle factory to this factory
    const LArMCParticle *const pLArMCParticle(dynamic_cast<const LArMCParticle *>(pObject));

    if (!pLArMCParticle)
        return pandora::STATUS_CODE_INVALID_PARAMETER;

    if (pandora::BINARY == fileWriter.GetFileType())
    {
        pandora::BinaryFileWriter &binaryFileWriter(dynamic_cast<pandora::BinaryFileWriter &>(fileWriter));
        PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, binaryFileWriter.WriteVariable(pLArMCParticle->GetNuanceCode()));

        if (m_version > 1)
            PANDORA_RETURN_RESULT_IF(
                pandora::STATUS_CODE_SUCCESS, !=, binaryFileWriter.WriteVariable(static_cast<int>(pLArMCParticle->GetProcess())));
    }
    else if (pandora::XML == fileWriter.GetFileType())
    {
        pandora::XmlFileWriter &xmlFileWriter(dynamic_cast<pandora::XmlFileWriter &>(fileWriter));
        PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, xmlFileWriter.WriteVariable("NuanceCode", pLArMCParticle->GetNuanceCode()));

        if (m_version > 1)
            PANDORA_RETURN_RESULT_IF(
                pandora::STATUS_CODE_SUCCESS, !=, xmlFileWriter.WriteVariable("Process", static_cast<int>(pLArMCParticle->GetProcess())));
    }
    else
    {
        return pandora::STATUS_CODE_INVALID_PARAMETER;
    }

    return pandora::STATUS_CODE_SUCCESS;
}

Member Data Documentation

unsigned int lar_content::LArMCParticleFactory::m_version

private

The LArMCParticle version.

Definition at line 177 of file LArMCParticle.h.

---

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

• larpandoracontent/larpandoracontent/LArObjects/LArMCParticle.h