HepMC Reference Documentation HepMC

StreamInfo.h

Go to the documentation of this file.

//--------------------------------------------------------------------------
#ifndef HEPMC_STREAM_INFO_H
#define HEPMC_STREAM_INFO_H

// garren@fnal.gov, March 2009
//
// This class contains the extra information needed when using streaming IO

#include <string>
#include "HepMC/Units.h"

namespace HepMC {

enum known_io { gen=1, ascii, extascii, ascii_pdt, extascii_pdt };


class StreamInfo {
public:
    StreamInfo( );
    ~StreamInfo() {}

    std::string IO_GenEvent_Key()          const { return m_io_genevent_start; }
    std::string IO_GenEvent_End()          const { return m_io_genevent_end; }

    std::string IO_Ascii_Key()             const { return m_io_ascii_start; }
    std::string IO_Ascii_End()             const { return m_io_ascii_end; }
    std::string IO_Ascii_PDT_Key()             const { return m_io_ascii_pdt_start; }
    std::string IO_Ascii_PDT_End()             const { return m_io_ascii_pdt_end; }

    std::string IO_ExtendedAscii_Key()     const { return m_io_extendedascii_start; }
    std::string IO_ExtendedAscii_End()     const { return m_io_extendedascii_end; }
    std::string IO_ExtendedAscii_PDT_Key()             const { return m_io_extendedascii_pdt_start; }
    std::string IO_ExtendedAscii_PDT_End()             const { return m_io_extendedascii_pdt_end; }

    int io_type() const { return m_io_type; }
    void set_io_type( int );

    bool has_key() const { return m_has_key; }
    void set_has_key( bool );
    
    Units::MomentumUnit io_momentum_unit() const { return m_io_momentum_unit; }
    Units::LengthUnit io_position_unit() const { return m_io_position_unit; }

    int stream_id() const { return m_stream_id; }
    
    bool finished_first_event() const { return m_finished_first_event_io; }
    void set_finished_first_event( bool b ) { m_finished_first_event_io = b; }

    void use_input_units( Units::MomentumUnit, Units::LengthUnit );
    
    bool reading_event_header();
    void set_reading_event_header(bool);

private: // data members
    bool        m_finished_first_event_io;
    // GenEvent I/O method keys
    std::string m_io_genevent_start;
    std::string m_io_ascii_start;
    std::string m_io_extendedascii_start;
    std::string m_io_genevent_end;
    std::string m_io_ascii_end;
    std::string m_io_extendedascii_end;
    // particle data I/O method keys
    std::string m_io_ascii_pdt_start;
    std::string m_io_extendedascii_pdt_start;
    std::string m_io_ascii_pdt_end;
    std::string m_io_extendedascii_pdt_end;
    // io information
    int         m_io_type;
    bool        m_has_key;
    // default io units - used only when reading a file with no units
    Units::MomentumUnit m_io_momentum_unit;
    Units::LengthUnit   m_io_position_unit;
    // used to keep identify the I/O stream
    unsigned int m_stream_id;
    static unsigned int m_stream_counter;
    // used to keep track when reading event
    bool m_reading_event_header;

};

} // HepMC

#endif  // HEPMC_STREAM_INFO_H
//--------------------------------------------------------------------------

---