Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Jetscape::JetScapeWriterFinalStateStream< T > Class Template Reference

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

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

Public Member Functions

 JetScapeWriterFinalStateStream ()
 
 JetScapeWriterFinalStateStream (string m_file_name_out)
 
virtual ~JetScapeWriterFinalStateStream ()
 
void Init ()
 
void Exec ()
 
virtual std::string GetName ()
 
bool GetStatus ()
 
void Close ()
 
void Write (weak_ptr< PartonShower > ps)
 
void Write (weak_ptr< Hadron > h)
 
void WriteHeaderToFile ()
 Gets called first, before all tasks write themselves.
 
void WriteEvent ()
 Gets called last, after all tasks have written themselves.
 
void Write (string s)
 
void WriteComment (string s)
 
void WriteWhiteSpace (string s)
 
- 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< Parton > p)
 
virtual void Write (weak_ptr< Jet > j)
 
virtual void Write (weak_ptr< Vertex > v)
 
virtual void Write (ostream *o)
 
virtual JetScapeEventHeaderGetHeader ()
 
- 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::XMLElementGetXMLElement (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< JetScapeTaskGetTaskAt (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 Attributes

T output_file
 Output file.
 
std::vector< std::shared_ptr
< JetScapeParticleBase > > 
particles
 
- Protected Attributes inherited from Jetscape::JetScapeWriter
string file_name_out
 
JetScapeEventHeader header
 

Additional Inherited Members

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

Detailed Description

template<class T>
class Jetscape::JetScapeWriterFinalStateStream< T >

Definition at line 37 of file JetScapeWriterFinalStateStream.h.

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

Constructor & Destructor Documentation

Definition at line 40 of file JetScapeWriterFinalStateStream.h.

View newest version in sPHENIX GitHub at line 40 of file JetScapeWriterFinalStateStream.h

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

Definition at line 40 of file JetScapeWriterFinalStateStream.cc.

View newest version in sPHENIX GitHub at line 40 of file JetScapeWriterFinalStateStream.cc

Definition at line 44 of file JetScapeWriterFinalStateStream.cc.

View newest version in sPHENIX GitHub at line 44 of file JetScapeWriterFinalStateStream.cc

References Close(), and VERBOSE.

+ Here is the call graph for this function:

Member Function Documentation

template<class T >
void Jetscape::JetScapeWriterFinalStateStream< T >::Close ( )
virtual

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 144 of file JetScapeWriterFinalStateStream.cc.

View newest version in sPHENIX GitHub at line 144 of file JetScapeWriterFinalStateStream.cc

References generate_particle_data_table::output_file.

template<class T >
void Jetscape::JetScapeWriterFinalStateStream< 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 116 of file JetScapeWriterFinalStateStream.cc.

View newest version in sPHENIX GitHub at line 116 of file JetScapeWriterFinalStateStream.cc

template<class T>
virtual std::string Jetscape::JetScapeWriterFinalStateStream< T >::GetName ( )
inlinevirtual
template<class T>
bool Jetscape::JetScapeWriterFinalStateStream< T >::GetStatus ( )
inlinevirtual

Implements Jetscape::JetScapeWriter.

Definition at line 48 of file JetScapeWriterFinalStateStream.h.

View newest version in sPHENIX GitHub at line 48 of file JetScapeWriterFinalStateStream.h

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

template<class T >
void Jetscape::JetScapeWriterFinalStateStream< 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 91 of file JetScapeWriterFinalStateStream.cc.

View newest version in sPHENIX GitHub at line 91 of file JetScapeWriterFinalStateStream.cc

References JSINFO, perf_headwind::name, and generate_particle_data_table::output_file.

template<class T >
void Jetscape::JetScapeWriterFinalStateStream< T >::Write ( weak_ptr< PartonShower ps)
virtual

Reimplemented from Jetscape::JetScapeWriter.

Reimplemented in Jetscape::JetScapeWriterFinalStateHadronsStream< T >.

Definition at line 124 of file JetScapeWriterFinalStateStream.cc.

View newest version in sPHENIX GitHub at line 124 of file JetScapeWriterFinalStateStream.cc

References Jetscape::PartonShower::GetFinalPartons(), and particles.

+ Here is the call graph for this function:

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

Reimplemented from Jetscape::JetScapeWriter.

Reimplemented in Jetscape::JetScapeWriterFinalStatePartonsStream< T >.

Definition at line 137 of file JetScapeWriterFinalStateStream.cc.

View newest version in sPHENIX GitHub at line 137 of file JetScapeWriterFinalStateStream.cc

References particles.

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

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 59 of file JetScapeWriterFinalStateStream.h.

View newest version in sPHENIX GitHub at line 59 of file JetScapeWriterFinalStateStream.h

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

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

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 62 of file JetScapeWriterFinalStateStream.h.

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

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

Gets called last, after all tasks have written themselves.

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 50 of file JetScapeWriterFinalStateStream.cc.

View newest version in sPHENIX GitHub at line 50 of file JetScapeWriterFinalStateStream.cc

References Jetscape::JetScapeXML::GetElementInt(), Jetscape::JetScapeXML::Instance(), generate_particle_data_table::output_file, merge_hashes::p, particle, particles, and to_string().

+ Here is the call graph for this function:

template<class T>
void Jetscape::JetScapeWriterFinalStateStream< T >::WriteHeaderToFile ( )
inlinevirtual

Gets called first, before all tasks write themselves.

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 56 of file JetScapeWriterFinalStateStream.h.

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

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

Reimplemented from Jetscape::JetScapeWriter.

Definition at line 63 of file JetScapeWriterFinalStateStream.h.

View newest version in sPHENIX GitHub at line 63 of file JetScapeWriterFinalStateStream.h

Member Data Documentation

template<class T>
T Jetscape::JetScapeWriterFinalStateStream< T >::output_file
protected
template<class T>
std::vector<std::shared_ptr<JetScapeParticleBase> > Jetscape::JetScapeWriterFinalStateStream< T >::particles
protected

Definition at line 67 of file JetScapeWriterFinalStateStream.h.

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


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