Granule

class Granule : public genNamedObj< Granule* >

Class that encapsulates the PHENIX granules

Inheritance:

Public Methods
void allocateGranule(): To allocate a granule
void deallocateGranule(): To deallocate a granule
void dump( ostream &os = cout ): Prints a full dump of the granule object to ostream os
static void dump_all( ostream &os = cout ): Calls dump on every declared granule
const char* getConfig_file(): Returns the configuration file of the granule
inline rcGTM* getGTM(): Returns the pointer to the GTM of this granule
const char* getName(): Returns the name of the granule
Granule(const char *name, const char *config_file = NULL ): Creator with 2 arguments
void identify( ostream &os = cout ): Prints a one-line summary to ostream os
int instantiateGranule( const char *pcConfigFile = NULL ): Instantiates all the objects related to the granule
bool isAllocated(): Returns true if the granule is allocated
static void listAll( ostream &os = cout ): Calls identify on every defined granule
inline void setGTM( rcGTM *pGTM ): To relate the GTM object with the granule

Inherited from genNamedObj:

Public Methods
static void add( const char *name, X x )
inline static X begin()
inline static X end()
static bool exists( const char *name )
static X get( const char *name )
int getLocation()
inline static int getNbElements()
static X getObject( const char *name )
static int getObjects( const char *name, list<X> &theList )
inline const char* getObjName()
inline static X next()
static void remove( const char *name )

Private Fields
static map < const char*, X, cstring_ordering_t > ::iterator m_It
static map < const char*, X, cstring_ordering_t > m_Map
char* m_Name

Documentation

Class that encapsulates the PHENIX granules. The list of granules is read from the run control generic configuration file at startup time and used internally to map GTMs to granules.

Granule(const char *name, const char *config_file = NULL )

Creator with 2 arguments. Granule name and (optionally) the configuration file that describes this granule.

void identify( ostream &os = cout )

Prints a one-line summary to ostream os

void dump( ostream &os = cout )