[u/mrichter/AliRoot.git] / HLT / trigger / AliHLTEventSummary.h

//-*- Mode: C++ -*-
// $Id$
#ifndef ALIHLTEVENTSUMMARY_H
#define ALIHLTEVENTSUMMARY_H

/* This file is property of and copyright by the ALICE HLT Project        * 
 * ALICE Experiment at CERN, All rights reserved.                         *
 * See cxx source for full Copyright notice                               */

/** @file   AliHLTEventSummary.h
    @author Jochen Thaeder
    @date   
    @brief  Summary class for run statistics, merges all detectors
*/

// see below for class documentation
// or
// refer to README to build package
// or
// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt   

#include "TObject.h"
#include "TObjArray.h"
#include "TString.h"
#include "AliHLTDataTypes.h"

/**
 * @class  AliHLTEventSummary
 * @brief  Summary  class for event statistics, merges all detectors
 *
 * The event statistic classes hold information about certain characteristica 
 * of the processed events. They are devided into 3 parts. A base class 
 * @see AliHLTEventStatistics for general Information, detector specific
 * classes like @see AliHLTTPCEventStatistics for the TPC and a summary class
 * @see AliHLTEventSummary which can hold several detector classes.
 *
 * This is the summary class.
 *
 * See base class @see AliHLTEventStatistics for further information.
 *
 * @ingroup alihlt_run_statistics alihlt_trigger
 */

class AliHLTEventSummary : public TObject {
  
public:
  
  /** constructor */
  AliHLTEventSummary();
  /** destructor */
  virtual ~AliHLTEventSummary();

  // -- event reject  ------------------------

  /** Reject this event */
  void RejectEvent()                              { fRejected = kFALSE;} 

  /** Check event is accepted
   *  @return kTRUE if accepted, kFALSE if rejected
   */
  Bool_t IsAccepted()                             { return fRejected;} 

  // -- run parameters ------------------------

  /** Set Run Number 
   *  @param i run number
   */
  void SetRunNumber( AliHLTUInt32_t i )           { fRunNumber = i; }

  /** Get Run Number 
   *  @return run number
   */
  AliHLTUInt32_t GetRunNumber()                   { return  fRunNumber;}

  /** Set Run Type 
   *  @param i run type
   */
  void SetRunType( AliHLTUInt32_t i )             { fRunType = i; }

  /** Get Run Type s
   *  @return run type
   */
  AliHLTUInt32_t GetRunType()                     { return fRunType; }

  // -- trigger parameters ------------------------

  /** Set ocurrance of trigger classe with index i
   *  @param u index of Trigger Class   
   *  @return kTRUE on success
   */
  void SetTriggerClass( AliHLTUInt64_t u )        { fTriggerClass = u; } 

  /** Get ocurrance of trigger classes 
   *  @return ptr to array of trigger classes
   */
  AliHLTUInt64_t GetTriggerClasses()              { return fTriggerClass; }
  
  // -- detector parameters ------------------------

  /** Detector run statistics classes 
   *  @return ptr to Detector arry
   */
  TObjArray* GetDetectorArray ()                  { return fDetectorArray; }

  /** Rest the Detector array, all elements are removed */
  void ResetDetectorArray()                       { if ( fDetectorArray ) fDetectorArray->Clear(); }

  /** Add another detector event statistics class to detector arry 
   *  @param obj to TObject, which should be added
   *  @return kTRUE on success
   */
  Bool_t AddDetector( TObject *obj );

private:

  /** copy constructor prohibited */
  AliHLTEventSummary (const AliHLTEventSummary&);

  /** assignment operator prohibited */
  AliHLTEventSummary& operator= (const AliHLTEventSummary&);

  /** Event rejected 
   *  - kFALSE is rejected
   *  - kTRUE is default
   */
  Bool_t fRejected;                              // see above

  /** Run Number */   
  AliHLTUInt32_t fRunNumber;                     // see above

  /** Run Type */
  AliHLTUInt32_t fRunType;                       // see above

  /** Trigger class */
  AliHLTUInt64_t fTriggerClass;                  // see above

  /** Detector run statistics classes */
  TObjArray* fDetectorArray;                     //! transient

  ClassDef(AliHLTEventSummary, 0);

};
#endif
Commit	Line	Data
2ff24e4c	1	//-- Mode: C++ --
	2	// $Id$
	3	#ifndef ALIHLTEVENTSUMMARY_H
	4	#define ALIHLTEVENTSUMMARY_H
	5
	6	/* This file is property of and copyright by the ALICE HLT Project *
	7	* ALICE Experiment at CERN, All rights reserved. *
	8	* See cxx source for full Copyright notice */
	9
	10	/** @file AliHLTEventSummary.h
	11	@author Jochen Thaeder
	12	@date
	13	@brief Summary class for run statistics, merges all detectors
	14	*/
	15
	16	// see below for class documentation
	17	// or
	18	// refer to README to build package
	19	// or
	20	// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
	21
	22	#include "TObject.h"
	23	#include "TObjArray.h"
	24	#include "TString.h"
	25	#include "AliHLTDataTypes.h"
	26
	27	/**
	28	* @class AliHLTEventSummary
	29	* @brief Summary class for event statistics, merges all detectors
	30	*
	31	* The event statistic classes hold information about certain characteristica
	32	* of the processed events. They are devided into 3 parts. A base class
	33	* @see AliHLTEventStatistics for general Information, detector specific
	34	* classes like @see AliHLTTPCEventStatistics for the TPC and a summary class
	35	* @see AliHLTEventSummary which can hold several detector classes.
	36	*
	37	* This is the summary class.
	38	*
	39	* See base class @see AliHLTEventStatistics for further information.
	40	*
	41	* @ingroup alihlt_run_statistics alihlt_trigger
	42	*/
	43
	44	class AliHLTEventSummary : public TObject {
	45
	46	public:
	47
	48	/** constructor */
	49	AliHLTEventSummary();
	50	/** destructor */
	51	virtual ~AliHLTEventSummary();
	52
	53	// -- event reject ------------------------
	54
	55	/** Reject this event */
	56	void RejectEvent() { fRejected = kFALSE;}
	57
	58	/** Check event is accepted
	59	* @return kTRUE if accepted, kFALSE if rejected
	60	*/
	61	Bool_t IsAccepted() { return fRejected;}
	62
	63	// -- run parameters ------------------------
	64
65	/** Set Run Number
66	* @param i run number
67	*/
68	void SetRunNumber( AliHLTUInt32_t i ) { fRunNumber = i; }
69
70	/** Get Run Number
71	* @return run number
72	*/
73	AliHLTUInt32_t GetRunNumber() { return fRunNumber;}
74
75	/** Set Run Type
76	* @param i run type
77	*/
78	void SetRunType( AliHLTUInt32_t i ) { fRunType = i; }
79
80	/** Get Run Type s
81	* @return run type
82	*/
83	AliHLTUInt32_t GetRunType() { return fRunType; }
84
85	// -- trigger parameters ------------------------
86
87	/** Set ocurrance of trigger classe with index i
88	* @param u index of Trigger Class
89	* @return kTRUE on success
90	*/
91	void SetTriggerClass( AliHLTUInt64_t u ) { fTriggerClass = u; }
92
93	/** Get ocurrance of trigger classes
94	* @return ptr to array of trigger classes
95	*/
96	AliHLTUInt64_t GetTriggerClasses() { return fTriggerClass; }
97
98	// -- detector parameters ------------------------
99
100	/** Detector run statistics classes
101	* @return ptr to Detector arry
102	*/
103	TObjArray* GetDetectorArray () { return fDetectorArray; }
104
105	/** Rest the Detector array, all elements are removed */
106	void ResetDetectorArray() { if ( fDetectorArray ) fDetectorArray->Clear(); }
107
108	/** Add another detector event statistics class to detector arry
109	* @param obj to TObject, which should be added
110	* @return kTRUE on success
111	*/
112	Bool_t AddDetector( TObject *obj );
113
114	private:
115
116	/** copy constructor prohibited */
117	AliHLTEventSummary (const AliHLTEventSummary&);
118
119	/** assignment operator prohibited */
120	AliHLTEventSummary& operator= (const AliHLTEventSummary&);
121
122	/** Event rejected
123	* - kFALSE is rejected
124	* - kTRUE is default
125	*/
126	Bool_t fRejected; // see above
127
128	/** Run Number */
129	AliHLTUInt32_t fRunNumber; // see above
130
131	/** Run Type */
132	AliHLTUInt32_t fRunType; // see above
133
134	/** Trigger class */
135	AliHLTUInt64_t fTriggerClass; // see above
136
137	/** Detector run statistics classes */
138	TObjArray* fDetectorArray; //! transient
139
140	ClassDef(AliHLTEventSummary, 0);
141
142	};
143	#endif