Page MenuHomeHEPForge
Files F11222289

HepMC3File.h
No OneTemporary
Actions

HepMC3File.h
View Options

// -*- C++ -*-
//
// HepMC3File.h is a part of ThePEG - Toolkit for HEP Event Generation
// Copyright (C) 1999-2017 Leif Lonnblad
//
// ThePEG is licenced under version 3 of the GPL, see COPYING for details.
// Please respect the MCnet academic guidelines, see GUIDELINES for details.
//
#ifndef THEPEG_HepMC3File_H
#define THEPEG_HepMC3File_H
//
// This is the declaration of the HepMC3File class.
//
#include <iostream>
#include <fstream>
#include "ThePEG/Handlers/AnalysisHandler.h"
#include "ThePEG/Repository/CurrentGenerator.h"
#include "ThePEG/Repository/EventGenerator.h"
#include "HepMC/IO/IO_Base.h"
namespace ThePEG {
/** \ingroup Analysis
* The HepMC3File class outputs ThePEG events in HepMC format.
*
* @see \ref HepMC3FileInterfaces "The interfaces"
* defined for HepMC3File.
*/
class HepMC3File: public AnalysisHandler {
public:
/** @name Standard constructors and destructors. */
//@{
/**
* The default constructor.
*/
HepMC3File();
/**
* The copy constructor.
*/
HepMC3File(const HepMC3File &);
//@}
public:
/** @name Virtual functions required by the AnalysisHandler class. */
//@{
/**
* Analyze a given Event. Note that a fully generated event
* may be presented several times, if it has been manipulated in
* between. The default version of this function will call transform
* to make a lorentz transformation of the whole event, then extract
* all final state particles and call analyze(tPVector) of this
* analysis object and those of all associated analysis objects. The
* default version will not, however, do anything on events which
* have not been fully generated, or have been manipulated in any
* way.
* @param event pointer to the Event to be analyzed.
* @param ieve the event number.
* @param loop the number of times this event has been presented.
* If negative the event is now fully generated.
* @param state a number different from zero if the event has been
* manipulated in some way since it was last presented.
*/
virtual void analyze(tEventPtr event, long ieve, int loop, int state);
//@}
public:
/** @name Functions used by the persistent I/O system. */
//@{
/**
* Function used to write out object persistently.
* @param os the persistent output stream written to.
*/
void persistentOutput(PersistentOStream & os) const;
/**
* Function used to read in object persistently.
* @param is the persistent input stream read from.
* @param version the version number of the object when written.
*/
void persistentInput(PersistentIStream & is, int version);
//@}
/**
* The standard Init function used to initialize the interfaces.
* Called exactly once for each class by the class description system
* before the main function starts or
* when this class is dynamically loaded.
*/
static void Init();
protected:
/** @name Clone Methods. */
//@{
/**
* Make a simple clone of this object.
* @return a pointer to the new object.
*/
virtual IBPtr clone() const;
/** Make a clone of this object, possibly modifying the cloned object
* to make it sane.
* @return a pointer to the new object.
*/
virtual IBPtr fullclone() const;
//@}
protected:
/** @name Standard Interfaced functions. */
//@{
/**
* Initialize this object. Called in the run phase just before
* a run begins.
*/
virtual void doinitrun();
/**
* Finalize this object. Called in the run phase just after a
* run has ended. Used eg. to write out statistics.
*/
virtual void dofinish();
//@}
private:
/**
* The static object used to initialize the description of this class.
* Indicates that this is a concrete class with persistent data.
*/
static ClassDescription<HepMC3File> initHepMC3File;
/**
* The assignment operator is private and must never be called.
* In fact, it should not even be implemented.
*/
HepMC3File & operator=(const HepMC3File &);
private:
/**
* Last event that should be written out as HepMC format
*/
long _eventNumber;
/**
* The HepMC filename
*/
string _filename;
/**
* The HepMC I/O handler
*/
HepMC::IO_Base *_hepmcio;
/**
* Selector for the choice of units
*/
int _unitchoice;
/**
* Choice of output precision in GenEvent format
*/
unsigned int _geneventPrecision;
};
}
#include "ThePEG/Utilities/ClassTraits.h"
namespace ThePEG {
/** @cond TRAITSPECIALIZATIONS */
/** This template specialization informs ThePEG about the
* base classes of HepMC3File. */
template <>
struct BaseClassTrait<HepMC3File,1> {
/** Typedef of the first base class of HepMC3File. */
typedef AnalysisHandler NthBase;
};
/** This template specialization informs ThePEG about the name of
* the HepMC3File class and the shared object where it is defined. */
template <>
struct ClassTraits<HepMC3File>
: public ClassTraitsBase<HepMC3File> {
/** Return a platform-independent class name */
static string className() { return "ThePEG::HepMCFile"; }
/** Return the name(s) of the shared library (or libraries) be loaded to get
* access to the HepMC3File class and any other class on which it depends
* (except the base class). */
static string library() { return "HepMCAnalysis.so"; }
};
/** @endcond */
}
#endif /* THEPEG_HepMC3File_H */

File Metadata

Mime Type
text/x-c++
Expires
Wed, May 14, 11:42 AM (10 h, 36 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
5111493
Default Alt Text
HepMC3File.h (5 KB)

Event Timeline