In This Package:

HepMC::IO_Ascii Class Reference

Strategy for reading or writing events/particleData as machine readable ascii to a file. More...

#include <IO_Ascii.h>

Inheritance diagram for HepMC::IO_Ascii:

[legend]Collaboration diagram for HepMC::IO_Ascii:[legend]List of all members.

Public Member Functions
	IO_Ascii (const char *filename="IO_Ascii.dat", std::ios::openmode mode=std::ios::out)
	constructor requiring a file name and std::ios mode
virtual	~IO_Ascii ()
void	write_event (const GenEvent *evt)
	write this event
bool	fill_next_event (GenEvent *evt)
	get the next event
void	write_particle_data_table (const ParticleDataTable *)
	write this ParticleDataTable
bool	fill_particle_data_table (ParticleDataTable *)
	fill this ParticleDataTable
void	write_comment (const std::string comment)
	insert a comment directly into the output file --- normally you only want to do this at the beginning or end of the file.
int	rdstate () const
	check the state of the IO stream
void	clear ()
	clear the IO stream
void	print (std::ostream &ostr=std::cout) const
	write to ostr
GenEvent *	read_next_event ()
	do not over-ride
ParticleDataTable *	read_particle_data_table ()
	do not over-ride
virtual GenEvent *&	operator>> (GenEvent *&)
	the same as read_next_event
virtual ParticleDataTable *&	operator>> (ParticleDataTable *&)
	the same as read_particle_data_table
virtual const GenEvent *&	operator<< (const GenEvent *&)
	the same as write_event
virtual GenEvent *&	operator<< (GenEvent *&)
	the same as write_event
virtual const ParticleDataTable *&	operator<< (const ParticleDataTable *&)
	the same as write_particle_data_table
virtual ParticleDataTable *&	operator<< (ParticleDataTable *&)
	the same as write_particle_data_table
Protected Member Functions
void	write_vertex (GenVertex *)
	write vertex information
void	write_particle (GenParticle *p)
	write particle information
void	write_particle_data (const ParticleData *d)
	write ParticleDataTable information
bool	write_end_listing ()
	write end tag
void	output (const double &)
	write double
void	output (const int &)
	write int
void	output (const long int &)
	write long int
void	output (const char &)
	write a single character
Private Member Functions
	IO_Ascii (const IO_Ascii &)
Private Attributes
std::ios::openmode	m_mode
std::fstream	m_file
bool	m_finished_first_event_io
CommonIO	m_common_io

---

Detailed Description

Strategy for reading or writing events/particleData as machine readable ascii to a file.

When instantiating, the mode of file to be created must be specified.

Definition at line 64 of file IO_Ascii.h.

---

Constructor & Destructor Documentation

HepMC::IO_Ascii::IO_Ascii	(	const char *	filename = "IO_Ascii.dat",
		std::ios::openmode	mode = std::ios::out
	)

constructor requiring a file name and std::ios mode

virtual HepMC::IO_Ascii::~IO_Ascii

(

)

[virtual]

HepMC::IO_Ascii::IO_Ascii

(

const IO_Ascii &

)

[inline, private]

Definition at line 103 of file IO_Ascii.h.

: IO_BaseClass() {}

---

Member Function Documentation

void HepMC::IO_Ascii::write_event

(

const GenEvent *

evt

)

[virtual]

write this event

Implements HepMC::IO_BaseClass.

bool HepMC::IO_Ascii::fill_next_event

(

GenEvent *

evt

)

[virtual]

get the next event

Implements HepMC::IO_BaseClass.

void HepMC::IO_Ascii::write_particle_data_table

(

const ParticleDataTable *

)

[virtual]

write this ParticleDataTable

Implements HepMC::IO_BaseClass.

bool HepMC::IO_Ascii::fill_particle_data_table

(

ParticleDataTable *

)

[virtual]

fill this ParticleDataTable

Implements HepMC::IO_BaseClass.

void HepMC::IO_Ascii::write_comment

(

const std::string

comment

)

insert a comment directly into the output file --- normally you only want to do this at the beginning or end of the file.

All comments are preceded with "HepMC::IO_Ascii-COMMENT\n"

int HepMC::IO_Ascii::rdstate

(

)

const [inline]

check the state of the IO stream

Definition at line 125 of file IO_Ascii.h.

{ return (int)m_file.rdstate(); }

void HepMC::IO_Ascii::clear

(

)

[inline]

clear the IO stream

Definition at line 126 of file IO_Ascii.h.

{ m_file.clear(); }

void HepMC::IO_Ascii::print

(

std::ostream &

ostr = std::cout

)

const [virtual]

write to ostr

Reimplemented from HepMC::IO_BaseClass.

void HepMC::IO_Ascii::write_vertex

(

GenVertex *

)

[protected]

write vertex information

void HepMC::IO_Ascii::write_particle

(

GenParticle *

p

)

[protected]

write particle information

void HepMC::IO_Ascii::write_particle_data

(

const ParticleData *

d

)

[protected]

write ParticleDataTable information

bool HepMC::IO_Ascii::write_end_listing

(

)

[protected]

write end tag

void HepMC::IO_Ascii::output

(

const double &

)

[inline, protected]

write double

Definition at line 115 of file IO_Ascii.h.

                                                  {
        if ( d == 0. ) {
            m_file << ' ' << (int)0;
        } else {
            m_file << ' ' << d;
        }
    }

void HepMC::IO_Ascii::output

(

const int &

)

[inline, protected]

write int

Definition at line 122 of file IO_Ascii.h.

{ m_file << ' ' << i; }

void HepMC::IO_Ascii::output

(

const long int &

)

[inline, protected]

write long int

Definition at line 123 of file IO_Ascii.h.

{ m_file << ' ' << i; }

void HepMC::IO_Ascii::output

(

const char &

)

[inline, protected]

write a single character

Definition at line 124 of file IO_Ascii.h.

{ m_file << c; }

GenEvent * HepMC::IO_BaseClass::read_next_event

(

)

[inline, inherited]

do not over-ride

creates a new event and fills it by calling the sister method read_next_event( GenEvent* )

Definition at line 87 of file IO_BaseClass.h.

                                                   {
        // 
        // 1. create an empty event container
        GenEvent* evt = new GenEvent();
        // 2. fill the evt container - if the read is successful, return the
        //    pointer, otherwise return null and delete the evt
        if ( fill_next_event( evt ) ) return evt;
        // note: the below delete is only reached if read fails
        //       ... thus there is not much overhead in new then delete 
        //       since this statement is rarely reached
        delete evt;
        return 0;
    }

ParticleDataTable * HepMC::IO_BaseClass::read_particle_data_table

(

)

[inline, inherited]

do not over-ride

creates a new particle data table and fills it by calling the sister method read_particle_data_table( ParticleDataTable* )

Definition at line 103 of file IO_BaseClass.h.

                                                                     {
        //
        // 1. create an empty pdt
        ParticleDataTable* pdt = new ParticleDataTable();
        // 2. fill the pdt container - if the read is successful, return the
        //    pointer, otherwise return null and delete the evt
        if ( fill_particle_data_table( pdt ) ) return pdt;
        // next statement is only reached if read fails
        delete pdt;
        return 0;
    }

GenEvent *& HepMC::IO_BaseClass::operator>>

(

GenEvent *&

)

[inline, virtual, inherited]

the same as read_next_event

Definition at line 121 of file IO_BaseClass.h.

                                                              {
        evt = read_next_event();
        return evt;
    }

ParticleDataTable *& HepMC::IO_BaseClass::operator>>

(

ParticleDataTable *&

)

[inline, virtual, inherited]

the same as read_particle_data_table

Definition at line 137 of file IO_BaseClass.h.

                                                                    {
        pdt = read_particle_data_table();
        return pdt;
    }

const GenEvent *& HepMC::IO_BaseClass::operator<<

(

const GenEvent *&

)

[inline, virtual, inherited]

the same as write_event

Definition at line 126 of file IO_BaseClass.h.

                                                                     {
        write_event( evt );
        return evt;
    }

GenEvent *& HepMC::IO_BaseClass::operator<<

(

GenEvent *&

)

[inline, virtual, inherited]

the same as write_event

Definition at line 132 of file IO_BaseClass.h.

                                                               {
        write_event( evt );
        return evt;
    }

const ParticleDataTable *& HepMC::IO_BaseClass::operator<<

(

const ParticleDataTable *&

)

[inline, virtual, inherited]

the same as write_particle_data_table

Definition at line 143 of file IO_BaseClass.h.

                                                                             {
        write_particle_data_table( pdt );
        return pdt;
    }

ParticleDataTable *& HepMC::IO_BaseClass::operator<<

(

ParticleDataTable *&

)

[inline, virtual, inherited]

the same as write_particle_data_table

Definition at line 149 of file IO_BaseClass.h.

                                                                              {
        write_particle_data_table( pdt );
        return pdt;
    }

---

Member Data Documentation

std::ios::openmode HepMC::IO_Ascii::m_mode [private]

Definition at line 105 of file IO_Ascii.h.

std::fstream HepMC::IO_Ascii::m_file [private]

Definition at line 106 of file IO_Ascii.h.

bool HepMC::IO_Ascii::m_finished_first_event_io [private]

Definition at line 107 of file IO_Ascii.h.

CommonIO HepMC::IO_Ascii::m_common_io [private]

Definition at line 108 of file IO_Ascii.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/external/HepMC/2.03.09/i686-slc5-gcc41-opt/include/HepMC/IO_Ascii.h

---