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

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

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

Public Member Functions

 JetScapeWriterStreamFilter ()
 
 JetScapeWriterStreamFilter (string m_file_name_out, unsigned char filter)
 
virtual ~JetScapeWriterStreamFilter ()
 
void Write (weak_ptr< PartonShower > ps)
 
void Write (weak_ptr< Parton > p)
 
void Write (weak_ptr< Vertex > v)
 
void Write (weak_ptr< Hadron > h)
 
- Public Member Functions inherited from Jetscape::JetScapeWriterStream< T >
 JetScapeWriterStream ()
 
 JetScapeWriterStream (string m_file_name_out)
 
virtual ~JetScapeWriterStream ()
 
void Init ()
 
void Exec ()
 
bool GetStatus ()
 
void Close ()
 
void WriteInitFileXMLMain ()
 
void WriteInitFileXMLUser ()
 
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 ()
 

Public Attributes

sigslot::signal1< vector
< shared_ptr< Hadron > > & > 		GetHadronList
 

Protected Attributes

unsigned char displayFilter
 
- Protected Attributes inherited from Jetscape::JetScapeWriterStream< T >
T output_file
 Output file.
 
- 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 ()
 
- Protected Member Functions inherited from Jetscape::JetScapeWriterStream< T >
template<>
RegisterJetScapeModule
< JetScapeWriterStream
< ofstream > > 		reg ("JetScapeWriterAscii")
 
template<>
RegisterJetScapeModule
< JetScapeWriterStream
< ogzstream > > 		regGZ ("JetScapeWriterAsciiGZ")
 
- Static Protected Attributes inherited from Jetscape::JetScapeWriterStream< T >
static RegisterJetScapeModule
< JetScapeWriterStream
< ofstream > > 		reg
 
static RegisterJetScapeModule
< JetScapeWriterStream
< ogzstream > > 		regGZ
 

Detailed Description

template<class T>
class Jetscape::JetScapeWriterStreamFilter< T >

Definition at line 33 of file JetScapeWriterStreamFilter.h.

View newest version in sPHENIX GitHub at line 33 of file JetScapeWriterStreamFilter.h

Constructor & Destructor Documentation

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

Definition at line 38 of file JetScapeWriterStreamFilter.h.

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

template<class T >
Jetscape::JetScapeWriterStreamFilter< T >::JetScapeWriterStreamFilter ( string  m_file_name_out,
unsigned char  filter 
)
inline

Definition at line 39 of file JetScapeWriterStreamFilter.h.

View newest version in sPHENIX GitHub at line 39 of file JetScapeWriterStreamFilter.h

References Jetscape::JetScapeWriterStreamFilter< T >::displayFilter, and filter.

template<class T >
virtual Jetscape::JetScapeWriterStreamFilter< T >::~JetScapeWriterStreamFilter ( )
inlinevirtual

Definition at line 43 of file JetScapeWriterStreamFilter.h.

View newest version in sPHENIX GitHub at line 43 of file JetScapeWriterStreamFilter.h

Member Function Documentation

template<class T >
void Jetscape::JetScapeWriterStreamFilter< T >::Write ( weak_ptr< PartonShower >  ps)
inlinevirtual

Reimplemented from Jetscape::JetScapeWriterStream< T >.

Definition at line 55 of file JetScapeWriterStreamFilter.h.

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

References Jetscape::JetScapeWriterStreamFilter< T >::displayFilter, JETSCAPEWRITER_PARTONSHOWER, and Jetscape::JetScapeWriterStream< T >::Write().

+ Here is the call graph for this function:

template<class T >
void Jetscape::JetScapeWriterStreamFilter< T >::Write ( weak_ptr< Parton >  p)
inlinevirtual

Reimplemented from Jetscape::JetScapeWriterStream< T >.

Definition at line 59 of file JetScapeWriterStreamFilter.h.

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

References Jetscape::JetScapeWriterStreamFilter< T >::displayFilter, JETSCAPEWRITER_PARTON, and Jetscape::JetScapeWriterStream< T >::Write().

+ Here is the call graph for this function:

template<class T >
void Jetscape::JetScapeWriterStreamFilter< T >::Write ( weak_ptr< Vertex >  v)
inlinevirtual

Reimplemented from Jetscape::JetScapeWriterStream< T >.

Definition at line 63 of file JetScapeWriterStreamFilter.h.

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

References Jetscape::JetScapeWriterStreamFilter< T >::displayFilter, JETSCAPEWRITER_VERTEX, and Jetscape::JetScapeWriterStream< T >::Write().

+ Here is the call graph for this function:

template<class T >
void Jetscape::JetScapeWriterStreamFilter< T >::Write ( weak_ptr< Hadron >  h)
inlinevirtual

Reimplemented from Jetscape::JetScapeWriterStream< T >.

Definition at line 67 of file JetScapeWriterStreamFilter.h.

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

References Jetscape::JetScapeWriterStreamFilter< T >::displayFilter, JETSCAPEWRITER_HADRON, and Jetscape::JetScapeWriterStream< T >::Write().

+ Here is the call graph for this function:

Member Data Documentation

template<class T >
unsigned char Jetscape::JetScapeWriterStreamFilter< T >::displayFilter
protected

Definition at line 79 of file JetScapeWriterStreamFilter.h.

View newest version in sPHENIX GitHub at line 79 of file JetScapeWriterStreamFilter.h

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

template<class T >
sigslot::signal1<vector<shared_ptr<Hadron> >& > Jetscape::JetScapeWriterStreamFilter< T >::GetHadronList

Definition at line 43 of file JetScapeWriterStreamFilter.h.

View newest version in sPHENIX GitHub at line 43 of file JetScapeWriterStreamFilter.h

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