Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
Jetscape::JetScapeWriter Class Referenceabstract

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

+ Inheritance diagram for Jetscape::JetScapeWriter:
+ Collaboration diagram for Jetscape::JetScapeWriter:

Public Member Functions

 JetScapeWriter ()
 
 JetScapeWriter (string m_file_name_out)
 
virtual ~JetScapeWriter ()
 
void SetOutputFileName (string m_file_name_out)
 
string GetOutputFileName ()
 
virtual bool GetStatus ()=0
 
virtual void Close ()
 
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 (weak_ptr< PartonShower > ps)
 
virtual void Write (string s)
 
virtual void WriteComment (string s)
 
virtual void WriteWhiteSpace (string s)
 
virtual void Write (ostream *o)
 
virtual void Write (weak_ptr< Hadron > h)
 
virtual void WriteHeaderToFile ()
 Gets called first, before all tasks write themselves.
 
virtual void WriteEvent ()
 Gets called last, after all tasks have written themselves.
 
virtual JetScapeEventHeader & GetHeader ()
 
- Public Member Functions inherited from Jetscape::JetScapeModuleBase
 JetScapeModuleBase ()
 
 JetScapeModuleBase (string m_name)
 
virtual ~JetScapeModuleBase ()
 
virtual void Init ()
 
virtual void Exec ()
 
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 Attributes

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

Definition at line 31 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 31 of file JetScapeWriter.h

Constructor & Destructor Documentation

Jetscape::JetScapeWriter::JetScapeWriter ( )
inline

Definition at line 34 of file JetScapeWriter.h.

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

References Jetscape::JetScapeTask::SetId().

+ Here is the call graph for this function:

Jetscape::JetScapeWriter::JetScapeWriter ( string  m_file_name_out)
inline

Definition at line 35 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 35 of file JetScapeWriter.h

References file_name_out.

virtual Jetscape::JetScapeWriter::~JetScapeWriter ( )
inlinevirtual

Definition at line 36 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 36 of file JetScapeWriter.h

Member Function Documentation

virtual void Jetscape::JetScapeWriter::Close ( )
inlinevirtual

Reimplemented in Jetscape::JetScapeWriterHepMC, Jetscape::JetScapeWriterRootHepMC, Jetscape::JetScapeWriterFinalStateStream< T >, Jetscape::JetScapeWriterStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

Definition at line 44 of file JetScapeWriter.h.

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

virtual JetScapeEventHeader& Jetscape::JetScapeWriter::GetHeader ( )
inlinevirtual

Definition at line 64 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 64 of file JetScapeWriter.h

References header.

Referenced by Jetscape::JetScapeWriterAsciiGZ::WriteHeaderToFile(), Jetscape::JetScapeWriterRootHepMC::WriteHeaderToFile(), and Jetscape::JetScapeWriterHepMC::WriteHeaderToFile().

+ Here is the caller graph for this function:

string Jetscape::JetScapeWriter::GetOutputFileName ( )
inline

Definition at line 41 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 41 of file JetScapeWriter.h

References file_name_out.

Referenced by Jetscape::JetScapeWriterAsciiGZ::Init(), Jetscape::JetScapeWriterRootHepMC::Init(), and Jetscape::JetScapeWriterHepMC::Init().

+ Here is the caller graph for this function:

virtual bool Jetscape::JetScapeWriter::GetStatus ( )
pure virtual

Implemented in Jetscape::JetScapeWriterHepMC, Jetscape::JetScapeWriterRootHepMC, Jetscape::JetScapeWriterFinalStateStream< T >, Jetscape::JetScapeWriterStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

virtual void Jetscape::JetScapeWriter::Open ( )
inlinevirtual

Definition at line 45 of file JetScapeWriter.h.

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

void Jetscape::JetScapeWriter::SetOutputFileName ( string  m_file_name_out)
inline

Definition at line 38 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 38 of file JetScapeWriter.h

References file_name_out.

Referenced by Jetscape::JetScapeWriterAsciiGZ::JetScapeWriterAsciiGZ().

+ Here is the caller graph for this function:

virtual void Jetscape::JetScapeWriter::Write ( weak_ptr< Parton >  p)
inlinevirtual

Reimplemented in Jetscape::JetScapeWriterStreamFilter< T >, Jetscape::JetScapeWriterStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

Definition at line 48 of file JetScapeWriter.h.

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

virtual void Jetscape::JetScapeWriter::Write ( weak_ptr< Jet >  j)
inlinevirtual

Definition at line 49 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 49 of file JetScapeWriter.h

virtual void Jetscape::JetScapeWriter::Write ( weak_ptr< Vertex >  v)
inlinevirtual

Reimplemented in Jetscape::JetScapeWriterStreamFilter< T >, Jetscape::JetScapeWriterStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

Definition at line 50 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 50 of file JetScapeWriter.h

virtual void Jetscape::JetScapeWriter::Write ( weak_ptr< PartonShower >  ps)
inlinevirtual

Reimplemented in Jetscape::JetScapeWriterFinalStateHadronsStream< T >, Jetscape::JetScapeWriterHepMC, Jetscape::JetScapeWriterRootHepMC, Jetscape::JetScapeWriterStreamFilter< T >, Jetscape::JetScapeWriterFinalStateStream< T >, Jetscape::JetScapeWriterStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

Definition at line 51 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 51 of file JetScapeWriter.h

virtual void Jetscape::JetScapeWriter::Write ( string  s)
inlinevirtual

Reimplemented in Jetscape::JetScapeWriterFinalStateStream< T >, Jetscape::JetScapeWriterStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

Definition at line 52 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 52 of file JetScapeWriter.h

virtual void Jetscape::JetScapeWriter::Write ( ostream *  o)
inlinevirtual

Definition at line 55 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 55 of file JetScapeWriter.h

virtual void Jetscape::JetScapeWriter::Write ( weak_ptr< Hadron >  h)
inlinevirtual

Reimplemented in Jetscape::JetScapeWriterFinalStatePartonsStream< T >, Jetscape::JetScapeWriterStreamFilter< T >, Jetscape::JetScapeWriterHepMC, Jetscape::JetScapeWriterRootHepMC, Jetscape::JetScapeWriterFinalStateStream< T >, Jetscape::JetScapeWriterStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

Definition at line 56 of file JetScapeWriter.h.

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

virtual void Jetscape::JetScapeWriter::WriteComment ( string  s)
inlinevirtual

Reimplemented in Jetscape::JetScapeWriterFinalStateStream< T >, Jetscape::JetScapeWriterStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

Definition at line 53 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 53 of file JetScapeWriter.h

virtual void Jetscape::JetScapeWriter::WriteEvent ( )
inlinevirtual

Gets called last, after all tasks have written themselves.

Reimplemented in Jetscape::JetScapeWriterHepMC, Jetscape::JetScapeWriterRootHepMC, Jetscape::JetScapeWriterStream< T >, Jetscape::JetScapeWriterFinalStateStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

Definition at line 62 of file JetScapeWriter.h.

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

virtual void Jetscape::JetScapeWriter::WriteHeaderToFile ( )
inlinevirtual

Gets called first, before all tasks write themselves.

Reimplemented in Jetscape::JetScapeWriterHepMC, Jetscape::JetScapeWriterRootHepMC, Jetscape::JetScapeWriterFinalStateStream< T >, Jetscape::JetScapeWriterStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

Definition at line 59 of file JetScapeWriter.h.

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

virtual void Jetscape::JetScapeWriter::WriteInitFileXML ( )
inlinevirtual

Definition at line 47 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 47 of file JetScapeWriter.h

virtual void Jetscape::JetScapeWriter::WriteWhiteSpace ( string  s)
inlinevirtual

Reimplemented in Jetscape::JetScapeWriterFinalStateStream< T >, Jetscape::JetScapeWriterStream< T >, and Jetscape::JetScapeWriterAsciiGZ.

Definition at line 54 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 54 of file JetScapeWriter.h

Member Data Documentation

string Jetscape::JetScapeWriter::file_name_out
protected

Definition at line 64 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 64 of file JetScapeWriter.h

Referenced by GetOutputFileName(), JetScapeWriter(), and SetOutputFileName().

JetScapeEventHeader Jetscape::JetScapeWriter::header
protected

Definition at line 68 of file JetScapeWriter.h.

View newest version in sPHENIX GitHub at line 68 of file JetScapeWriter.h

Referenced by GetHeader().

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