Cleanup of documentation and code.
[u/mrichter/AliRoot.git] / HLT / MUON / AliHLTMUONEvent.cxx
1 /**************************************************************************
2  * This file is property of and copyright by the ALICE HLT Project        * 
3  * All rights reserved.                                                   *
4  *                                                                        *
5  * Primary Authors:                                                       *
6  *   Artur Szostak <artursz@iafrica.com>                                  *
7  *                                                                        *
8  * Permission to use, copy, modify and distribute this software and its   *
9  * documentation strictly for non-commercial purposes is hereby granted   *
10  * without fee, provided that the above copyright notice appears in all   *
11  * copies and that both the copyright notice and this permission notice   *
12  * appear in the supporting documentation. The authors make no claims     *
13  * about the suitability of this software for any purpose. It is          * 
14  * provided "as is" without express or implied warranty.                  *
15  **************************************************************************/
16
17 /* $Id: $ */
18
19 ///
20 /// @file   AliHLTMUONEvent.cxx
21 /// @author Artur Szostak <artursz@iafrica.com>
22 /// @date   29 Sep 2007
23 /// @brief  Implementation of the AliHLTMUONEvent class.
24 ///
25 /// The class is used to store all ROOTified data objects from the dHLT chain
26 /// for a single event together.
27
28 #include "AliHLTMUONEvent.h"
29 #include "AliHLTMUONDecision.h"
30 #include <iostream>
31
32 ClassImp(AliHLTMUONEvent);
33
34
35 const AliHLTMUONDecision* AliHLTMUONEvent::FindDecision() const
36 {
37         /// Finds the decision object in the event from the list of dHLT objects.
38         /// There should only be one such object in the event. If not, then only
39         /// the first object found is returned. You will need to manually search
40         /// for the other objects.
41         /// \returns  The AliHLTMUONDecision object in the event or NULL if none exists.
42         
43         for (Int_t i = 0; i < fArray.GetEntriesFast(); i++)
44         {
45                 if (fArray[i]->IsA() == AliHLTMUONDecision::Class())
46                 {
47                         return static_cast<const AliHLTMUONDecision*>(fArray[i]);
48                 }
49         }
50         
51         return NULL;
52 }
53
54
55 void AliHLTMUONEvent::Print(Option_t* option) const
56 {
57         ///
58         /// Inherited from TObject. Prints the contents of the event objects in fArray.
59         /// \param option  This is an option string that is just passed on to individual
60         ///     objects in the event's fArray list of objects.
61         ///
62         
63         std::cout << "################## EVENT: " << fEventId << " ##################" << std::endl;
64         for (Int_t i = 0; i < fArray.GetEntriesFast(); i++)
65                 if (fArray[i] != NULL) fArray[i]->Print(option);
66 }