lar_content::LArCaloHitFactory Class Reference

LArCaloHitFactory responsible for object creation. More...

#include "LArCaloHit.h"

Inheritance diagram for lar_content::LArCaloHitFactory:

Public Member Functions
	LArCaloHitFactory (const unsigned int version=1)
	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 LArCaloHit version. More...

Detailed Description

LArCaloHitFactory responsible for object creation.

Definition at line 110 of file LArCaloHit.h.

Constructor & Destructor Documentation

lar_content::LArCaloHitFactory::LArCaloHitFactory ( const unsigned int  version = 1 )

inline

Constructor.

Parameters

version

the LArCaloHit version

Definition at line 245 of file LArCaloHit.h.

                                                                      :
    m_version(version)
{
}

Member Function Documentation

pandora::StatusCode lar_content::LArCaloHitFactory::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 259 of file LArCaloHit.h.

{
    const LArCaloHitParameters &larCaloHitParameters(dynamic_cast<const LArCaloHitParameters &>(parameters));
    pObject = new LArCaloHit(larCaloHitParameters);

    return pandora::STATUS_CODE_SUCCESS;
}

LArCaloHitFactory::Parameters * lar_content::LArCaloHitFactory::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 252 of file LArCaloHit.h.

{
    return (new LArCaloHitParameters);
}

pandora::StatusCode lar_content::LArCaloHitFactory::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 269 of file LArCaloHit.h.

References lar_content::LArCaloHitParameters::m_daughterVolumeId, lar_content::LArCaloHitParameters::m_larTPCVolumeId, and m_version.

{
    // ATTN: To receive this call-back must have already set file reader mc particle factory to this factory
    unsigned int larTPCVolumeId(std::numeric_limits<unsigned int>::max());
    unsigned int daughterVolumeId(0);

    if (pandora::BINARY == fileReader.GetFileType())
    {
        pandora::BinaryFileReader &binaryFileReader(dynamic_cast<pandora::BinaryFileReader &>(fileReader));
        PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, binaryFileReader.ReadVariable(larTPCVolumeId));
        if (m_version > 1)
            PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, binaryFileReader.ReadVariable(daughterVolumeId));
    }
    else if (pandora::XML == fileReader.GetFileType())
    {
        pandora::XmlFileReader &xmlFileReader(dynamic_cast<pandora::XmlFileReader &>(fileReader));
        PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, xmlFileReader.ReadVariable("LArTPCVolumeId", larTPCVolumeId));
        if (m_version > 1)
            PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, xmlFileReader.ReadVariable("DaughterVolumeId", daughterVolumeId));
    }
    else
    {
        return pandora::STATUS_CODE_INVALID_PARAMETER;
    }

    LArCaloHitParameters &larCaloHitParameters(dynamic_cast<LArCaloHitParameters &>(parameters));
    larCaloHitParameters.m_larTPCVolumeId = larTPCVolumeId;
    larCaloHitParameters.m_daughterVolumeId = daughterVolumeId;

    return pandora::STATUS_CODE_SUCCESS;
}

pandora::StatusCode lar_content::LArCaloHitFactory::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 303 of file LArCaloHit.h.

References lar_content::LArCaloHit::GetDaughterVolumeId(), lar_content::LArCaloHit::GetLArTPCVolumeId(), and m_version.

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

    if (!pLArCaloHit)
        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(pLArCaloHit->GetLArTPCVolumeId()));
        if (m_version > 1)
            PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, binaryFileWriter.WriteVariable(pLArCaloHit->GetDaughterVolumeId()));
    }
    else if (pandora::XML == fileWriter.GetFileType())
    {
        pandora::XmlFileWriter &xmlFileWriter(dynamic_cast<pandora::XmlFileWriter &>(fileWriter));
        PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, xmlFileWriter.WriteVariable("LArTPCVolumeId", pLArCaloHit->GetLArTPCVolumeId()));
        if (m_version > 1)
            PANDORA_RETURN_RESULT_IF(
                pandora::STATUS_CODE_SUCCESS, !=, xmlFileWriter.WriteVariable("DaughterVolumeId", pLArCaloHit->GetDaughterVolumeId()));
    }
    else
    {
        return pandora::STATUS_CODE_INVALID_PARAMETER;
    }

    return pandora::STATUS_CODE_SUCCESS;
}

Member Data Documentation

unsigned int lar_content::LArCaloHitFactory::m_version

private

The LArCaloHit version.

Definition at line 152 of file LArCaloHit.h.

Referenced by Read(), and Write().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArCaloHit.h