Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PHNode Class Referenceabstract

#include <coresoftware/blob/master/offline/framework/phool/PHNode.h>

+ Inheritance diagram for PHNode:
+ Collaboration diagram for PHNode:

Public Member Functions

 PHNode (const std::string &)
 
 PHNode (const std::string &, const std::string &)
 
virtual ~PHNode ()
 
PHNodegetParent () const
 
bool isPersistent () const
 
void makePersistent ()
 
const std::string getObjectType () const
 
const std::string getType () const
 
const std::string getName () const
 
const std::string getClass () const
 
void setParent (PHNode *p)
 
void setName (const std::string &n)
 
void setObjectType (const std::string &n)
 
virtual void prune ()=0
 
virtual void print (const std::string &)=0
 
virtual void forgetMe (PHNode *)=0
 
virtual bool write (PHIOManager *, const std::string &="")=0
 
virtual void setResetFlag (const bool b)
 
virtual bool getResetFlag () const
 
void makeTransient ()
 

Protected Attributes

PHNodeparent = nullptr
 
bool persistent = true
 
std::string type = "PHNode"
 
std::string objecttype
 
std::string name
 
bool reset_able = true
 
std::string objectclass
 

Private Member Functions

 PHNode ()=delete
 
 PHNode (const PHNode &)=delete
 
PHNodeoperator= (const PHNode &)=delete
 

Detailed Description

Definition at line 12 of file PHNode.h.

View newest version in sPHENIX GitHub at line 12 of file PHNode.h

Constructor & Destructor Documentation

PHNode::PHNode ( const std::string &  n)

Definition at line 17 of file PHNode.cc.

View newest version in sPHENIX GitHub at line 17 of file PHNode.cc

PHNode::PHNode ( const std::string &  n,
const std::string &  typ 
)

Definition at line 22 of file PHNode.cc.

View newest version in sPHENIX GitHub at line 22 of file PHNode.cc

References n, name, and PHWHERE.

PHNode::~PHNode ( )
virtual

Definition at line 53 of file PHNode.cc.

View newest version in sPHENIX GitHub at line 53 of file PHNode.cc

References forgetMe(), and parent.

+ Here is the call graph for this function:

PHNode::PHNode ( )
privatedelete
PHNode::PHNode ( const PHNode )
privatedelete

Member Function Documentation

virtual void PHNode::forgetMe ( PHNode )
pure virtual

Implemented in PHCompositeNode, PHDataNode< T >, and PHDataNode< PHDWORD >.

Referenced by ~PHNode().

+ Here is the caller graph for this function:

const std::string PHNode::getClass ( ) const
inline

Definition at line 27 of file PHNode.h.

View newest version in sPHENIX GitHub at line 27 of file PHNode.h

References objectclass.

Referenced by operator<<().

+ Here is the caller graph for this function:

const std::string PHNode::getName ( ) const
inline

Definition at line 26 of file PHNode.h.

View newest version in sPHENIX GitHub at line 26 of file PHNode.h

References name.

Referenced by PHCompositeNode::addNode(), PHNodeIterator::cd(), Fun4AllDstInputManager::fileopen(), PHNodeIterator::findFirst(), operator<<(), PHNodeReset::perform(), PHNodeDump::perform(), and PHNodeIntegrate::perform().

+ Here is the caller graph for this function:

const std::string PHNode::getObjectType ( ) const
inline

Definition at line 24 of file PHNode.h.

View newest version in sPHENIX GitHub at line 24 of file PHNode.h

References objecttype.

Referenced by PHNodeReset::perform(), and PHNodeIntegrate::perform().

+ Here is the caller graph for this function:

PHNode* PHNode::getParent ( ) const
inline

Definition at line 21 of file PHNode.h.

View newest version in sPHENIX GitHub at line 21 of file PHNode.h

References parent.

Referenced by PHNodeIterator::cd().

+ Here is the caller graph for this function:

virtual bool PHNode::getResetFlag ( ) const
inlinevirtual

Definition at line 37 of file PHNode.h.

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

References reset_able.

Referenced by PHNodeReset::perform().

+ Here is the caller graph for this function:

const std::string PHNode::getType ( ) const
inline

Definition at line 25 of file PHNode.h.

View newest version in sPHENIX GitHub at line 25 of file PHNode.h

References type.

Referenced by PHNodeDump::AddDumpObject(), PHNodeIterator::cd(), PHNodeIterator::findFirst(), PHNodeIterator::forEach(), operator<<(), PHNodeReset::perform(), PHNodeDump::perform(), and PHNodeIntegrate::perform().

+ Here is the caller graph for this function:

bool PHNode::isPersistent ( ) const
inline

Definition at line 22 of file PHNode.h.

View newest version in sPHENIX GitHub at line 22 of file PHNode.h

References persistent.

Referenced by PHCompositeNode::prune().

+ Here is the caller graph for this function:

void PHNode::makePersistent ( )
inline

Definition at line 23 of file PHNode.h.

View newest version in sPHENIX GitHub at line 23 of file PHNode.h

References persistent.

Referenced by Fun4AllDstOutputManager::Write(), and Fun4AllDstOutputManager::WriteNode().

+ Here is the caller graph for this function:

void PHNode::makeTransient ( )
inline

Definition at line 38 of file PHNode.h.

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

References persistent.

Referenced by Fun4AllDstOutputManager::Write(), and Fun4AllDstOutputManager::WriteNode().

+ Here is the caller graph for this function:

PHNode& PHNode::operator= ( const PHNode )
privatedelete
virtual void PHNode::print ( const std::string &  )
pure virtual

Implemented in PHCompositeNode, PHDataNode< T >, and PHDataNode< PHDWORD >.

Referenced by PHCompositeNode::print().

+ Here is the caller graph for this function:

virtual void PHNode::prune ( )
pure virtual

Implemented in PHCompositeNode, PHDataNode< T >, and PHDataNode< PHDWORD >.

Referenced by PHCompositeNode::prune().

+ Here is the caller graph for this function:

void PHNode::setName ( const std::string &  n)
inline

Definition at line 29 of file PHNode.h.

View newest version in sPHENIX GitHub at line 29 of file PHNode.h

References n, and name.

void PHNode::setObjectType ( const std::string &  n)
inline

Definition at line 30 of file PHNode.h.

View newest version in sPHENIX GitHub at line 30 of file PHNode.h

References n, and objecttype.

Referenced by PHNodeIOManager::reconstructNodeTree().

+ Here is the caller graph for this function:

void PHNode::setParent ( PHNode p)
inline

Definition at line 28 of file PHNode.h.

View newest version in sPHENIX GitHub at line 28 of file PHNode.h

References merge_hashes::p, and parent.

Referenced by PHCompositeNode::addNode().

+ Here is the caller graph for this function:

virtual void PHNode::setResetFlag ( const bool  b)
inlinevirtual

Definition at line 36 of file PHNode.h.

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

References KFPMath::b, and reset_able.

virtual bool PHNode::write ( PHIOManager ,
const std::string &  = "" 
)
pure virtual

Implemented in PHCompositeNode, PHIODataNode< T >, PHDataNode< T >, PHDataNode< PHDWORD >, and PHRawDataNode.

Referenced by PHCompositeNode::write().

+ Here is the caller graph for this function:

Member Data Documentation

std::string PHNode::objectclass
protected

Definition at line 47 of file PHNode.h.

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

Referenced by getClass(), and PHIODataNode< T >::PHIODataNode().

std::string PHNode::objecttype
protected

Definition at line 44 of file PHNode.h.

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

Referenced by getObjectType(), and setObjectType().

PHNode* PHNode::parent = nullptr
protected

Definition at line 41 of file PHNode.h.

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

Referenced by getParent(), PHHepMCParticleSelectorDecayProductChain::GetParent(), PHHepMCParticleSelectorDecayProductChain::process_event(), setParent(), and ~PHNode().

bool PHNode::persistent = true
protected

Definition at line 42 of file PHNode.h.

View newest version in sPHENIX GitHub at line 42 of file PHNode.h

Referenced by isPersistent(), makePersistent(), and makeTransient().

bool PHNode::reset_able = true
protected

Definition at line 46 of file PHNode.h.

View newest version in sPHENIX GitHub at line 46 of file PHNode.h

Referenced by getResetFlag(), and setResetFlag().

std::string PHNode::type = "PHNode"
protected

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