Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Jetscape::JetScapeWriterStream< T > Class Template Reference

#include <JETSCAPE/blob/main/src/framework/JetScapeWriterStream.h>

+ Inheritance diagram for Jetscape::JetScapeWriterStream< T >:
+ Collaboration diagram for Jetscape::JetScapeWriterStream< T >:

Public Member Functions

 JetScapeWriterStream ()
 
 JetScapeWriterStream (string m_file_name_out)
 
virtual ~JetScapeWriterStream ()
 
void Init ()
 
void Exec ()
 
bool GetStatus ()
 
void Close ()
 
void WriteInitFileXMLMain ()
 
void WriteInitFileXMLUser ()
 
void Write (weak_ptr< PartonShower > ps)
 
void Write (weak_ptr< Parton > p)
 
void Write (weak_ptr< Vertex > v)
 
void Write (weak_ptr< Hadron > h)
 
void WriteHeaderToFile ()
 Gets called first, before all tasks write themselves.
 
void Write (string s)
 
void WriteComment (string s)
 
void WriteWhiteSpace (string s)
 
void WriteEvent ()
 Gets called last, after all tasks have written themselves.
 
- Public Member Functions inherited from Jetscape::JetScapeWriter
 JetScapeWriter ()
 
 JetScapeWriter (string m_file_name_out)
 
virtual ~JetScapeWriter ()
 
void SetOutputFileName (string m_file_name_out)
 
string GetOutputFileName ()
 
virtual void Open ()
 
virtual void WriteInitFileXML ()
 
virtual void Write (weak_ptr< Jet > j)
 
virtual void Write (ostream *o)
 
virtual JetScapeEventHeader & GetHeader ()
 
- Public Member Functions inherited from Jetscape::JetScapeModuleBase
 JetScapeModuleBase ()
 
 JetScapeModuleBase (string m_name)
 
virtual ~JetScapeModuleBase ()
 
virtual void Clear ()
 
void SetXMLMainFileName (string m_name)
 
string GetXMLMainFileName ()
 
void SetXMLUserFileName (string m_name)
 
string GetXMLUserFileName ()
 
shared_ptr< std::mt19937 > GetMt19937Generator ()
 
tinyxml2::XMLElement * GetXMLElement (std::initializer_list< const char * > path, bool isRequired=true)
 
std::string GetXMLElementText (std::initializer_list< const char * > path, bool isRequired=true)
 
int GetXMLElementInt (std::initializer_list< const char * > path, bool isRequired=true)
 
double GetXMLElementDouble (std::initializer_list< const char * > path, bool isRequired=true)
 
- Public Member Functions inherited from Jetscape::JetScapeTask
 JetScapeTask ()
 
virtual ~JetScapeTask ()
 
virtual void Finish ()
 
virtual void ExecuteTasks ()
 
virtual void ExecuteTask ()
 
virtual void InitTask ()
 
virtual void InitTasks ()
 
virtual void ClearTasks ()
 
virtual void ClearTask ()
 
virtual void FinishTask ()
 
virtual void FinishTasks ()
 
virtual void WriteTasks (weak_ptr< JetScapeWriter > w)
 
virtual void WriteTask (weak_ptr< JetScapeWriter > w)
 
virtual void CollectHeader (weak_ptr< JetScapeWriter > w)
 
virtual void CollectHeaders (weak_ptr< JetScapeWriter > w)
 
virtual void Add (shared_ptr< JetScapeTask > m_tasks)
 
virtual const int GetMyTaskNumber () const
 
const vector< shared_ptr
< JetScapeTask > > 		GetTaskList () const
 
shared_ptr< JetScapeTask > GetTaskAt (int i)
 
void EraseTaskLast ()
 
void EraseTaskAt (int i)
 
void ResizeTaskList (int i)
 
void ClearTaskList ()
 
int GetNumberOfTasks ()
 
const bool GetActive () const
 
void SetActive (bool m_active_exec)
 
void SetId (string m_id)
 
const string GetId () const
 
const shared_ptr
< JetScapeModuleMutex > 		GetMutex () const
 
void SetMutex (shared_ptr< JetScapeModuleMutex > m_mutex)
 
- Public Member Functions inherited from sigslot::has_slots< sigslot::multi_threaded_local >
 has_slots ()
 
 has_slots (const has_slots &hs)
 
void signal_connect (_signal_base< sigslot::multi_threaded_local > *sender)
 
void signal_disconnect (_signal_base< sigslot::multi_threaded_local > *sender)
 
virtual ~has_slots ()
 
void disconnect_all ()
 

Protected Member Functions

template<>
RegisterJetScapeModule
< JetScapeWriterStream
< ofstream > > 		reg ("JetScapeWriterAscii")
 
template<>
RegisterJetScapeModule
< JetScapeWriterStream
< ogzstream > > 		regGZ ("JetScapeWriterAsciiGZ")
 

Protected Attributes

T output_file
 Output file.
 
- Protected Attributes inherited from Jetscape::JetScapeWriter
string file_name_out
 
JetScapeEventHeader header
 

Static Protected Attributes

static RegisterJetScapeModule
< JetScapeWriterStream
< ofstream > > 		reg
 
static RegisterJetScapeModule
< JetScapeWriterStream
< ogzstream > > 		regGZ
 

Additional Inherited Members

- Static Public Member Functions inherited from Jetscape::JetScapeModuleBase
static int GetCurrentEvent ()
 
static void IncrementCurrentEvent ()
 

Detailed Description

template<class T>
class Jetscape::JetScapeWriterStream< T >

Definition at line 34 of file JetScapeWriterStream.h.

View newest version in sPHENIX GitHub at line 34 of file JetScapeWriterStream.h

Constructor & Destructor Documentation

template<class T>
Jetscape::JetScapeWriterStream< T >::JetScapeWriterStream ( )
inline

Definition at line 37 of file JetScapeWriterStream.h.

View newest version in sPHENIX GitHub at line 37 of file JetScapeWriterStream.h

template<class T >
Jetscape::JetScapeWriterStream< T >::JetScapeWriterStream ( string  m_file_name_out)

Definition at line 32 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 32 of file JetScapeWriterStream.cc

template<class T >
Jetscape::JetScapeWriterStream< T >::~JetScapeWriterStream ( )
virtual

Definition at line 36 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 36 of file JetScapeWriterStream.cc

References Close(), and VERBOSE.

+ Here is the call graph for this function:

Member Function Documentation

template<class T>
void Jetscape::JetScapeWriterStream< T >::Close ( )
inlinevirtual

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 45 of file JetScapeWriterStream.h.

View newest version in sPHENIX GitHub at line 45 of file JetScapeWriterStream.h

References Jetscape::JetScapeWriterStream< T >::output_file.

template<class T >
void Jetscape::JetScapeWriterStream< T >::Exec ( )
virtual

A virtual function to define a default Exec() function for a JetScapeModuleBase. It can be overridden by different modules/tasks.

Reimplemented from Jetscape::JetScapeModuleBase.

Definition at line 112 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 112 of file JetScapeWriterStream.cc

template<class T>
bool Jetscape::JetScapeWriterStream< T >::GetStatus ( )
inlinevirtual

Implements Jetscape::JetScapeWriter.

Definition at line 44 of file JetScapeWriterStream.h.

View newest version in sPHENIX GitHub at line 44 of file JetScapeWriterStream.h

References Jetscape::JetScapeWriterStream< T >::output_file.

template<class T >
void Jetscape::JetScapeWriterStream< T >::Init ( )
virtual

A virtual function for a default initialization of a JetScapeModuleBase. It also checks whether a XML file is loaded or not.

Reimplemented from Jetscape::JetScapeModuleBase.

Definition at line 100 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 100 of file JetScapeWriterStream.cc

References JSINFO, and generate_particle_data_table::output_file.

template<>
RegisterJetScapeModule< JetScapeWriterStream< ofstream > > Jetscape::JetScapeWriterStream< ofstream >::reg ( "JetScapeWriterAscii"  )
protected
template<>
RegisterJetScapeModule< JetScapeWriterStream< ogzstream > > Jetscape::JetScapeWriterStream< ogzstream >::regGZ ( "JetScapeWriterAsciiGZ"  )
protected
template<class T >
void Jetscape::JetScapeWriterStream< T >::Write ( weak_ptr< PartonShower >  ps)
virtual

Reimplemented from Jetscape::JetScapeWriter.

Reimplemented in Jetscape::JetScapeWriterStreamFilter< T >.

Definition at line 140 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 140 of file JetScapeWriterStream.cc

References to_string(), and Write().

Referenced by Jetscape::JetScapeWriterStreamFilter< T >::Write().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<class T >
void Jetscape::JetScapeWriterStream< T >::Write ( weak_ptr< Parton >  p)
virtual

Reimplemented from Jetscape::JetScapeWriter.

Reimplemented in Jetscape::JetScapeWriterStreamFilter< T >.

Definition at line 86 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 86 of file JetScapeWriterStream.cc

References generate_particle_data_table::output_file.

template<class T >
void Jetscape::JetScapeWriterStream< T >::Write ( weak_ptr< Vertex >  v)
virtual

Reimplemented from Jetscape::JetScapeWriter.

Reimplemented in Jetscape::JetScapeWriterStreamFilter< T >.

Definition at line 93 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 93 of file JetScapeWriterStream.cc

References generate_particle_data_table::output_file.

template<class T >
void Jetscape::JetScapeWriterStream< T >::Write ( weak_ptr< Hadron >  h)
virtual

Reimplemented from Jetscape::JetScapeWriter.

Reimplemented in Jetscape::JetScapeWriterStreamFilter< T >.

Definition at line 166 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 166 of file JetScapeWriterStream.cc

References generate_particle_data_table::output_file.

template<class T>
void Jetscape::JetScapeWriterStream< T >::Write ( string  s)
inlinevirtual

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 56 of file JetScapeWriterStream.h.

View newest version in sPHENIX GitHub at line 56 of file JetScapeWriterStream.h

References Jetscape::JetScapeWriterStream< T >::output_file.

template<class T>
void Jetscape::JetScapeWriterStream< T >::WriteComment ( string  s)
inlinevirtual

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 57 of file JetScapeWriterStream.h.

View newest version in sPHENIX GitHub at line 57 of file JetScapeWriterStream.h

References Jetscape::JetScapeWriterStream< T >::output_file.

template<class T >
void Jetscape::JetScapeWriterStream< T >::WriteEvent ( )
virtual

Gets called last, after all tasks have written themselves.

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 81 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 81 of file JetScapeWriterStream.cc

template<class T >
void Jetscape::JetScapeWriterStream< T >::WriteHeaderToFile ( )
virtual

Gets called first, before all tasks write themselves.

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 42 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 42 of file JetScapeWriterStream.cc

References to_string(), VERBOSE, and Write().

+ Here is the call graph for this function:

template<class T >
void Jetscape::JetScapeWriterStream< T >::WriteInitFileXMLMain ( )

Definition at line 119 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 119 of file JetScapeWriterStream.cc

References tinyxml2::XMLPrinter::CStr(), Jetscape::JetScapeXML::GetXMLDocumentMain(), Jetscape::JetScapeXML::GetXMLMainFileName(), Jetscape::JetScapeXML::Instance(), JSDEBUG, generate_particle_data_table::output_file, and tinyxml2::XMLDocument::Print().

+ Here is the call graph for this function:

template<class T >
void Jetscape::JetScapeWriterStream< T >::WriteInitFileXMLUser ( )

Definition at line 129 of file JetScapeWriterStream.cc.

View newest version in sPHENIX GitHub at line 129 of file JetScapeWriterStream.cc

References tinyxml2::XMLPrinter::CStr(), Jetscape::JetScapeXML::GetXMLDocumentUser(), Jetscape::JetScapeXML::GetXMLUserFileName(), Jetscape::JetScapeXML::Instance(), JSDEBUG, generate_particle_data_table::output_file, and tinyxml2::XMLDocument::Print().

+ Here is the call graph for this function:

template<class T>
void Jetscape::JetScapeWriterStream< T >::WriteWhiteSpace ( string  s)
inlinevirtual

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 58 of file JetScapeWriterStream.h.

View newest version in sPHENIX GitHub at line 58 of file JetScapeWriterStream.h

References Jetscape::JetScapeWriterStream< T >::output_file.

Member Data Documentation

template<class T>
T Jetscape::JetScapeWriterStream< T >::output_file
protected

Output file.

Definition at line 62 of file JetScapeWriterStream.h.

View newest version in sPHENIX GitHub at line 62 of file JetScapeWriterStream.h

Referenced by Jetscape::JetScapeWriterStream< T >::Close(), Jetscape::JetScapeWriterStream< T >::GetStatus(), Jetscape::JetScapeWriterStream< T >::Write(), Jetscape::JetScapeWriterStream< T >::WriteComment(), and Jetscape::JetScapeWriterStream< T >::WriteWhiteSpace().

template<class T>
RegisterJetScapeModule<JetScapeWriterStream<ofstream> > Jetscape::JetScapeWriterStream< T >::reg
staticprotected

Definition at line 66 of file JetScapeWriterStream.h.

View newest version in sPHENIX GitHub at line 66 of file JetScapeWriterStream.h

template<class T>
RegisterJetScapeModule<JetScapeWriterStream<ogzstream> > Jetscape::JetScapeWriterStream< T >::regGZ
staticprotected

Definition at line 67 of file JetScapeWriterStream.h.

View newest version in sPHENIX GitHub at line 67 of file JetScapeWriterStream.h

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