| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

DayaBay::GenHeader Class Reference

HeaderObject for kinematics generators. More...

#include <GenHeader.h>

Inheritance diagram for DayaBay::GenHeader:

[legend]
Collaboration diagram for DayaBay::GenHeader:
[legend]
List of all members.

Public Types

 Unknown = 0
 StableInProdGen = 1
 DecayedByProdGen = 2
 DocumentationParticle = 3
enum  statusType { Unknown = 0, StableInProdGen = 1, DecayedByProdGen = 2, DocumentationParticle = 3 }
 Status code in HepMC::GenParticle. More...
typedef std::vector< IHeader * > Vector
typedef std::vector< const
IHeader * > 
ConstVector

Public Member Functions

virtual const std::string & defLoc () const
 GenHeader ()
 Default Constructor.
virtual ~GenHeader ()
 Destructor.
virtual const CLIDclID () const
void setEvent (HepMC::GenEvent *event)
 Set the GenEvent, GenHeader takes ownership.
std::ostream & fillStream (std::ostream &s) const
 Serialize to an ostream.
const std::string & generatorName () const
 Retrieve const Generator Name.
void setGeneratorName (const std::string &value)
 Update Generator Name.
const HepMC::GenEventevent () const
 Retrieve const HepMC generator event.
HepMC::GenEventevent ()
 Retrieve HepMC generator event.
virtual const std::string & defLoc ()
void setInputHeaders (const std::vector< const DayaBay::IHeader * > &iheaders)
void addInputHeader (const DayaBay::IHeader *iheader)
const TimeStamptimeStamp () const
void setTimeStamp (const TimeStamp &ts)
const std::vector< const DayaBay::IHeader * > findHeaders (const CLID &clid) const
const Contextcontext () const
void setContext (const Context &value)
int execNumber () const
void setExecNumber (int value)
const std::vector< unsigned
long > & 
randomState () const
void setRandomState (const std::vector< unsigned long > &value)
const std::vector< const DayaBay::IHeader * > & inputHeaders () const
const DayaBay::JobIdjobId () const
void setJobId (const DayaBay::JobId &value)
virtual void setOutputAddress (const GenericAddress *roa)
virtual void setInputAddress (const GenericAddress *ria)
virtual const TimeStampearliest () const
void setEarliest (const TimeStamp &value)
virtual const TimeStamplatest () const
void setLatest (const TimeStamp &value)
virtual const GenericAddressoutputAddress () const
virtual const GenericAddressinputAddress () const
void setRegistry (IRegistry *pRegistry)
IRegistryregistry () const
LinkManagerlinkMgr () const
unsigned char version () const
void setVersion (unsigned char vsn)
unsigned long refCount () const
virtual unsigned long addRef ()
virtual unsigned long release ()
const std::string & name () const
virtual StreamBufferserialize (StreamBuffer &s)
virtual StreamBufferserialize (StreamBuffer &s) const

Static Public Member Functions

static const std::string & defaultLocation ()
 Give access to default location from class scope.
static const CLIDclassID ()
static void * operator new (size_t size)
 operator new
static void * operator new (size_t size, void *pObj)
 placement operator new it is needed by libstdc++ 3.2.3 (e.g.
static void operator delete (void *p)
 operator delete
static void operator delete (void *p, void *pObj)
 placement operator delete not sure if really needed, but it does not harm

Private Attributes

std::string m_generatorName
 Generator Name.
HepMC::GenEventm_event
 HepMC generator event.

Friends

friend friend std::ostream & operator<< (std::ostream &s, const DataObject &obj)

Detailed Description

HeaderObject for kinematics generators.

Author:
bv@bnl.gov created Mon Apr 11 04:05:40 2011

Definition at line 49 of file GenHeader.h.


Member Enumeration Documentation

enum DayaBay::GenHeader::statusType

Status code in HepMC::GenParticle.

Enumerator:
Unknown 
StableInProdGen 
DecayedByProdGen 
DocumentationParticle 

Definition at line 58 of file GenHeader.h.

00058                    { Unknown = 0,
00059                      StableInProdGen = 1,
00060                      DecayedByProdGen = 2,
00061                      DocumentationParticle = 3
00062       };


Constructor & Destructor Documentation

DayaBay::GenHeader::GenHeader (  )  [inline]

Default Constructor.

Definition at line 65 of file GenHeader.h.

00065                 : m_generatorName("Unknown"),
00066                   m_event(0) {}

DayaBay::GenHeader::~GenHeader (  )  [virtual]

Destructor.

Definition at line 4 of file GenHeader.cc.

00005 {
00006     delete m_event;
00007     m_event = 0;
00008 }


Member Function Documentation

static const std::string& DayaBay::GenHeader::defaultLocation (  )  [inline, static]

Give access to default location from class scope.

Reimplemented from DayaBay::HeaderObject.

Definition at line 54 of file GenHeader.h.

00054 { return GenHeaderLocation::Default; }

virtual const std::string& DayaBay::GenHeader::defLoc (  )  const [inline, virtual]

Reimplemented from DayaBay::HeaderObject.

Definition at line 55 of file GenHeader.h.

00055 { return GenHeaderLocation::Default; }

const CLID & DayaBay::GenHeader::clID (  )  const [inline, virtual]

Reimplemented from DayaBay::HeaderObject.

Definition at line 163 of file GenHeader.h.

00164 {
00165   return DayaBay::GenHeader::classID();
00166 }

const CLID & DayaBay::GenHeader::classID (  )  [inline, static]

Reimplemented from DayaBay::HeaderObject.

Definition at line 168 of file GenHeader.h.

00169 {
00170   return CLID_GenHeader;
00171 }

void DayaBay::GenHeader::setEvent ( HepMC::GenEvent event  ) 

Set the GenEvent, GenHeader takes ownership.

Definition at line 10 of file GenHeader.cc.

00011 {
00012     delete m_event;
00013     m_event = value;
00014 }

std::ostream & GenHeader::fillStream ( std::ostream &  s  )  const [virtual]

Serialize to an ostream.

Reimplemented from DayaBay::HeaderObject.

Definition at line 16 of file GenHeader.cc.

00017 {
00018     HeaderObject::fillStream(s);
00019     s << "{ " << "generatorName :       " << m_generatorName << std::endl
00020       << "event : {\n";
00021     if (m_event) {
00022         m_event->print(s);
00023     }
00024     else {
00025         s << "NULL GenEvent data";
00026     }
00027     s << "\n}\n";
00028     return s;
00029 }

const std::string & DayaBay::GenHeader::generatorName (  )  const [inline]

Retrieve const Generator Name.

Definition at line 173 of file GenHeader.h.

00174 {
00175   return m_generatorName;
00176 }

void DayaBay::GenHeader::setGeneratorName ( const std::string &  value  )  [inline]

Update Generator Name.

Definition at line 178 of file GenHeader.h.

00179 {
00180   m_generatorName = value;
00181 }

const HepMC::GenEvent * DayaBay::GenHeader::event (  )  const [inline]

Retrieve const HepMC generator event.

Definition at line 183 of file GenHeader.h.

00184 {
00185   return m_event;
00186 }

HepMC::GenEvent * DayaBay::GenHeader::event (  )  [inline]

Retrieve HepMC generator event.

Definition at line 188 of file GenHeader.h.

00189 {
00190   return m_event;
00191 }

static void* DayaBay::GenHeader::operator new ( size_t  size  )  [inline, static]

operator new

Reimplemented from DayaBay::HeaderObject.

Definition at line 100 of file GenHeader.h.

00101     {
00102       return ( sizeof(GenHeader) == size ? 
00103                boost::singleton_pool<GenHeader, sizeof(GenHeader)>::malloc() :
00104                ::operator new(size) );
00105     }

static void* DayaBay::GenHeader::operator new ( size_t  size,
void *  pObj 
) [inline, static]

placement operator new it is needed by libstdc++ 3.2.3 (e.g.

in std::vector) it is not needed in libstdc++ >= 3.4

Reimplemented from DayaBay::HeaderObject.

Definition at line 110 of file GenHeader.h.

00111     {
00112       return ::operator new (size,pObj);
00113     }

static void DayaBay::GenHeader::operator delete ( void *  p  )  [inline, static]

operator delete

Reimplemented from DayaBay::HeaderObject.

Definition at line 116 of file GenHeader.h.

00117     {
00118       boost::singleton_pool<GenHeader, sizeof(GenHeader)>::is_from(p) ?
00119       boost::singleton_pool<GenHeader, sizeof(GenHeader)>::free(p) :
00120       ::operator delete(p);
00121     }

static void DayaBay::GenHeader::operator delete ( void *  p,
void *  pObj 
) [inline, static]

placement operator delete not sure if really needed, but it does not harm

Reimplemented from DayaBay::HeaderObject.

Definition at line 125 of file GenHeader.h.

00126     {
00127       ::operator delete (p, pObj);
00128     }


Member Data Documentation

std::string DayaBay::GenHeader::m_generatorName [private]

Generator Name.

Definition at line 134 of file GenHeader.h.

HepMC::GenEvent* DayaBay::GenHeader::m_event [private]

HepMC generator event.

Definition at line 135 of file GenHeader.h.


The documentation for this class was generated from the following files:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Mon Apr 11 20:33:11 2011 for GenEvent by doxygen 1.4.7