herwig is hosted by Hepforge, IPPP Durham
Herwig++  2.7.0
Analysis2::Histogram2Output Class Reference

Base class for Histogram2 output. More...

#include <Histogram2Output.h>

Inheritance diagram for Analysis2::Histogram2Output:

List of all members.

Public Member Functions

void initialize (const string &name)
 Initialize the curret ostream to point to name.
virtual void put (Histogram2Ptr, const Histogram2Options &, const string &dataChannel)
 Output the given histogram.
virtual void initialize ()
 Initialize.
virtual void finalize ()
 Finalize.
Standard constructors and destructors.
 Histogram2Output ()
 The default constructor.
 Histogram2Output (const Histogram2Output &)
 The copy constructor.
virtual ~Histogram2Output ()
 The destructor.
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently.
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently.

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces.

Protected Member Functions

virtual ostream & currentOStream ()
 Return the currently used ostream.
string prefix () const
 Get the output prefix or filename.
string mctitle () const
 Get the model name.
Clone Methods.
virtual IBPtr clone () const
 Make a simple clone of this object.
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane.
Standard Interfaced functions.
virtual void doinitrun ()
 Initialize this object.
virtual void dofinish ()
 Finalize this object.

Private Member Functions

Histogram2Outputoperator= (const Histogram2Output &)
 The assignment operator is private and must never be called.

Private Attributes

string _prefix
 The prefix.
string _mctitle
 The MC model used.
ofstream _out
 Pointer to currently used ostream.

Static Private Attributes

static ClassDescription
< Histogram2Output
initHistogram2Output
 The static object used to initialize the description of this class.

Detailed Description

Base class for Histogram2 output.

Author:
Simon Plaetzer
See also:
The interfaces defined for Histogram2Output.

Definition at line 102 of file Histogram2Output.h.


Member Function Documentation

virtual IBPtr Analysis2::Histogram2Output::clone ( ) const [inline, protected, virtual]

Make a simple clone of this object.

Returns:
a pointer to the new object.

Implements ThePEG::InterfacedBase.

Reimplemented in Analysis2::GnuplotOutput.

virtual void Analysis2::Histogram2Output::dofinish ( ) [inline, protected, virtual]

Finalize this object.

Called in the run phase just after a run has ended. Used eg. to write out statistics.

Reimplemented from ThePEG::InterfacedBase.

virtual void Analysis2::Histogram2Output::doinitrun ( ) [inline, protected, virtual]

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

virtual void Analysis2::Histogram2Output::finalize ( ) [inline, virtual]

Finalize.

Similar to dofinish, in fact called by dofinish, but should _not_ call generator(), as it may be used 'offline' to combine parallel runs.

Reimplemented in Analysis2::GnuplotOutput.

virtual IBPtr Analysis2::Histogram2Output::fullclone ( ) const [inline, protected, virtual]

Make a clone of this object, possibly modifying the cloned object to make it sane.

Returns:
a pointer to the new object.

Reimplemented from ThePEG::InterfacedBase.

Reimplemented in Analysis2::GnuplotOutput.

static void Analysis2::Histogram2Output::Init ( ) [static]

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.

Reimplemented from ThePEG::Interfaced.

Reimplemented in Analysis2::GnuplotOutput.

void Analysis2::Histogram2Output::initialize ( const string &  name)

Initialize the curret ostream to point to name.

This is a helper only, it has to be called by either the implemented AnalysisHandler or the out method.

virtual void Analysis2::Histogram2Output::initialize ( ) [inline, virtual]

Initialize.

Similar to doinitrun, in fact called by doinitrun, but should _not_ call generator(), as it may be used 'offline' to combine parallel runs.

Reimplemented in Analysis2::GnuplotOutput.

Histogram2Output& Analysis2::Histogram2Output::operator= ( const Histogram2Output ) [private]

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

Function used to read in object persistently.

Parameters:
isthe persistent input stream read from.
versionthe version number of the object when written.

Reimplemented from ThePEG::Interfaced.

Reimplemented in Analysis2::GnuplotOutput.

Function used to write out object persistently.

Parameters:
osthe persistent output stream written to.

Reimplemented from ThePEG::Interfaced.

Reimplemented in Analysis2::GnuplotOutput.

virtual void Analysis2::Histogram2Output::put ( Histogram2Ptr  ,
const Histogram2Options ,
const string &  dataChannel 
) [virtual]

Output the given histogram.

The default just dumps to an ascii file.

Reimplemented in Analysis2::GnuplotOutput.


Member Data Documentation

The static object used to initialize the description of this class.

Indicates that this is a concrete class with persistent data.

Definition at line 262 of file Histogram2Output.h.


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