HepMC3 event record library
Public Member Functions | Private Member Functions | Private Attributes
WriterDOT Class Reference

Detailed Description

GenEvent I/O output to dot files that should be processed by graphviz or other software.

Examples:
convert_example.cc.

Definition at line 21 of file WriterDOT.h.

#include <WriterDOT.h>

+ Inheritance diagram for WriterDOT:
+ Collaboration diagram for WriterDOT:

Public Member Functions

 WriterDOT (const std::string &filename, shared_ptr< GenRunInfo > run=shared_ptr< GenRunInfo >())
 Constructor. More...
 
 WriterDOT (std::ostream &stream, shared_ptr< GenRunInfo > run=shared_ptr< GenRunInfo >())
 Constructor from ostream. More...
 
void write_event (const GenEvent &evt)
 Write event to file. More...
 
bool failed ()
 Return status of the stream. More...
 
void close ()
 Close file stream. More...
 
void set_style (const int &istyle)
 Close file stream. More...
 
void set_run_info (shared_ptr< GenRunInfo > run)
 Set the global GenRunInfo object. More...
 
shared_ptr< GenRunInforun_info () const
 Get the global GenRunInfo object. More...
 

Private Member Functions

void allocate_buffer ()
 
void flush ()
 
void forced_flush ()
 

Private Attributes

std::ofstream m_file
 Output file. More...
 
std::ostream * m_stream
 Output stream. More...
 
int m_style
 style of dot file More...
 
char * m_buffer
 Stream buffer. More...
 
char * m_cursor
 Cursor inside stream buffer. More...
 
unsigned long m_buffer_size
 Buffer size. More...
 

Constructor & Destructor Documentation

◆ WriterDOT() [1/2]

WriterDOT ( const std::string &  filename,
shared_ptr< GenRunInfo run = shared_ptr<GenRunInfo>() 
)

Constructor.

Warning
If file already exists, it will be cleared before writing

Definition at line 4 of file WriterDOT.cc.

References ERROR, and WriterDOT::m_file.

◆ WriterDOT() [2/2]

WriterDOT ( std::ostream &  stream,
shared_ptr< GenRunInfo run = shared_ptr<GenRunInfo>() 
)

Constructor from ostream.

Definition at line 16 of file WriterDOT.cc.

Member Function Documentation

◆ close()

void close ( )
virtual

Close file stream.

Implements Writer.

Definition at line 26 of file WriterDOT.cc.

References WriterDOT::m_stream.

◆ failed()

bool failed ( )
inlinevirtual

Return status of the stream.

Implements Writer.

Definition at line 34 of file WriterDOT.h.

References WriterDOT::close(), and WriterDOT::m_file.

◆ run_info()

shared_ptr<GenRunInfo> run_info ( ) const
inlineinherited

Get the global GenRunInfo object.

Definition at line 42 of file Writer.h.

References Writer::m_run_info.

◆ set_run_info()

void set_run_info ( shared_ptr< GenRunInfo run)
inlineinherited

Set the global GenRunInfo object.

Definition at line 37 of file Writer.h.

References Writer::m_run_info.

◆ set_style()

void set_style ( const int &  istyle)
inline

Close file stream.

Definition at line 40 of file WriterDOT.h.

References WriterDOT::m_style.

◆ write_event()

void write_event ( const GenEvent evt)
virtual

Field Documentation

◆ m_buffer

char* m_buffer
private

Stream buffer.

Definition at line 51 of file WriterDOT.h.

◆ m_buffer_size

unsigned long m_buffer_size
private

Buffer size.

Definition at line 53 of file WriterDOT.h.

◆ m_cursor

char* m_cursor
private

Cursor inside stream buffer.

Definition at line 52 of file WriterDOT.h.

◆ m_file

std::ofstream m_file
private

Output file.

Definition at line 48 of file WriterDOT.h.

◆ m_stream

std::ostream* m_stream
private

Output stream.

Definition at line 49 of file WriterDOT.h.

◆ m_style

int m_style
private

style of dot file

Definition at line 50 of file WriterDOT.h.


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