lar_content::LArMCParticleFactory Class Reference

LArMCParticleFactory responsible for object creation. More...

#include "LArMCParticle.h"

Inheritance diagram for lar_content::LArMCParticleFactory:

Collaboration diagram for lar_content::LArMCParticleFactory:

Public Types
typedef object_creation::MCParticle::Parameters	Parameters
typedef object_creation::MCParticle::Object	Object

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

Protected Member Functions
virtual StatusCode	Create (const Parameters &parameters, const Object *&pObject) const=0
	Create an object with the given parameters.

Private Attributes
unsigned int	m_version
	The LArMCParticle version.

Detailed Description

LArMCParticleFactory responsible for object creation.

Definition at line 135 of file LArMCParticle.h.

Member Typedef Documentation

Object

typedef object_creation::MCParticle::Object pandora::ObjectFactory< object_creation::MCParticle::Parameters , object_creation::MCParticle::Object >::Object

inherited

Definition at line 29 of file ObjectFactory.h.

Parameters

typedef object_creation::MCParticle::Parameters pandora::ObjectFactory< object_creation::MCParticle::Parameters , object_creation::MCParticle::Object >::Parameters

inherited

Definition at line 28 of file ObjectFactory.h.

Constructor & Destructor Documentation

LArMCParticleFactory()

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

inline

Constructor.

Parameters

version

the LArMCParticle version

Definition at line 223 of file LArMCParticle.h.

Member Function Documentation

Create() [1/2]

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.

Create() [2/2]

virtual StatusCode pandora::ObjectFactory< object_creation::MCParticle::Parameters , object_creation::MCParticle::Object >::Create ( const Parameters &  parameters, const Object *&  pObject  ) const

protectedpure virtualinherited

Create an object with the given parameters.

Parameters

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

NewParameters()

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

inlinevirtual

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

Returns

the address of the new parameters instance

Implements pandora::ObjectFactory< object_creation::MCParticle::Parameters, object_creation::MCParticle::Object >.

Definition at line 229 of file LArMCParticle.h.

Read() [1/2]

virtual StatusCode pandora::ObjectFactory< object_creation::MCParticle::Parameters , object_creation::MCParticle::Object >::Read ( Parameters &  parameters, FileReader &  fileReader  ) const

pure virtualinherited

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

Read() [2/2]

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.

Here is the call graph for this function:

Write() [1/2]

virtual StatusCode pandora::ObjectFactory< object_creation::MCParticle::Parameters , object_creation::MCParticle::Object >::Write ( const Object *const  pObject, FileWriter &  fileWriter  ) const

pure virtualinherited

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

Write() [2/2]

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.

Here is the call graph for this function:

Member Data Documentation

m_version

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:

• LArContent/larpandoracontent/LArObjects/LArMCParticle.h