EPIC::WriterModule Class Reference

Inheritance diagram for EPIC::WriterModule:

Public Member Functions
	WriterModule (const std::string &className)
	WriterModule (const WriterModule &other)
virtual	~WriterModule ()
virtual void	configure (const ElemUtils::Parameters &parameters)
virtual bool	runTest () const
virtual void	open ()=0
virtual void	saveGenerationInformation (const GenerationInformation &generationInformation)=0
virtual void	close ()=0
virtual void	write (const Event &event)=0
virtual void	write (const std::vector< Event > &events)=0
const std::string &	getPath () const
void	setPath (const std::string &path)
Public Member Functions inherited from EPIC::EpicModuleObject
virtual	~EpicModuleObject ()
virtual bool	runTest () const =0
size_t	getSeed () const

Static Public Attributes
static const std::string	WRITER_MODULE_CLASS_NAME
	Class name used in parsing XML.
static const std::string	PARAMETER_NAME_PATH

Protected Member Functions
virtual void	initModule ()
virtual void	isModuleWellConfigured ()
Protected Member Functions inherited from EPIC::EpicModuleObject
	EpicModuleObject (const std::string &className, PARTONS::ChannelType::Type channelType)
	EpicModuleObject (const EpicModuleObject &other)

Protected Attributes
std::string	m_path
	Path to output file.
Protected Attributes inherited from EPIC::EpicModuleObject
size_t	m_seed
	Random seed.

Constructor & Destructor Documentation

WriterModule() [1/2]

EPIC::WriterModule::WriterModule

(

const std::string &

className

)

Constructor.

WriterModule() [2/2]

EPIC::WriterModule::WriterModule

(

const WriterModule &

other

)

Copy constructor.

~WriterModule()

virtual EPIC::WriterModule::~WriterModule ( )

virtual

Destructor.

Member Function Documentation

close()

virtual void EPIC::WriterModule::close ( )

pure virtual

Close file.

Implemented in EPIC::WriterHepMC3, EPIC::WriterHepMC3AsciiAndPythia6, and EPIC::WriterPythia6.

getPath()

const std::string & EPIC::WriterModule::getPath

(

)

const

Get path.

open()

virtual void EPIC::WriterModule::open ( )

pure virtual

Open file.

Implemented in EPIC::WriterHepMC3, EPIC::WriterHepMC3AsciiAndPythia6, and EPIC::WriterPythia6.

runTest()

virtual bool EPIC::WriterModule::runTest ( ) const

virtual

Definition of test.

Implements EPIC::EpicModuleObject.

saveGenerationInformation()

virtual void EPIC::WriterModule::saveGenerationInformation ( const GenerationInformation &  generationInformation )

pure virtual

Save run information.

Implemented in EPIC::WriterHepMC3, EPIC::WriterHepMC3AsciiAndPythia6, and EPIC::WriterPythia6.

setPath()

void EPIC::WriterModule::setPath

(

const std::string &

path

)

Set path.

write() [1/2]

virtual void EPIC::WriterModule::write ( const Event &  event )

pure virtual

Write single event (file must be open).

Implemented in EPIC::WriterHepMC3, EPIC::WriterHepMC3AsciiAndPythia6, and EPIC::WriterPythia6.

write() [2/2]

virtual void EPIC::WriterModule::write ( const std::vector< Event > &  events )

pure virtual

Write vector of events (file must be open).

Implemented in EPIC::WriterHepMC3, EPIC::WriterHepMC3AsciiAndPythia6, and EPIC::WriterPythia6.

Member Data Documentation

PARAMETER_NAME_PATH

const std::string EPIC::WriterModule::PARAMETER_NAME_PATH

static

String used to set path through WriterModule::configure().

---

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

• /Users/pawel/projects/epic/NEW2/epic/include/modules/writer/WriterModule.h