HLT/PHOS/latex/AliHLTLogging_8h.tex

   1 \section{/home/perthi/cern/aliroot/Ali\-Root\_\-head020507/HLT/BASE/Ali\-HLTLogging.h File Reference}
   2 \label{AliHLTLogging_8h}\index{/home/perthi/cern/aliroot/AliRoot_head020507/HLT/BASE/AliHLTLogging.h@{/home/perthi/cern/aliroot/AliRoot\_\-head020507/HLT/BASE/AliHLTLogging.h}}
   3
   4
   5 \subsection{Detailed Description}
   6 HLT module logging primitives.
   7
   8 \begin{Desc}
   9 \item[Author:]Matthias Richter, Timm Steinbeck \end{Desc}
  10 \begin{Desc}
  11 \item[Date:]\end{Desc}
  12
  13
  14 Definition in file {\bf Ali\-HLTLogging.h}.
  15
  16 {\tt \#include \char`\"{}Ali\-HLTData\-Types.h\char`\"{}}\par
  17 {\tt \#include \char`\"{}Ali\-HLTStd\-Includes.h\char`\"{}}\par
  18 {\tt \#include \char`\"{}TObject.h\char`\"{}}\par
  19 {\tt \#include \char`\"{}TArray\-C.h\char`\"{}}\par
  20 \subsection*{Classes}
  21 \begin{CompactItemize}
  22 \item
  23 class {\bf Ali\-HLTLogging}
  24 \item
  25 class {\bf Ali\-HLTKeyword}
  26 \end{CompactItemize}
  27 \subsection*{Defines}
  28 \begin{CompactItemize}
  29 \item
  30 \#define {\bf HLTMessage}()\ Logging\-Varargs(k\-HLTLog\-None,      NULL , NULL , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )
  31 \item
  32 \#define {\bf FUNCTIONNAME}()\ \char`\"{}???\char`\"{}
  33 \item
  34 \#define {\bf HLTBenchmark}()\ Logging\-Varargs(k\-HLTLog\-Benchmark, Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )
  35 \item
  36 \#define {\bf HLTDebug}()\ Logging\-Varargs(k\-HLTLog\-Debug,     Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )
  37 \item
  38 \#define {\bf HLTInfo}()\ Logging\-Varargs(k\-HLTLog\-Info,      Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )
  39 \item
  40 \#define {\bf HLTWarning}()\ Logging\-Varargs(k\-HLTLog\-Warning,   Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )
  41 \item
  42 \#define {\bf HLTError}()\ Logging\-Varargs(k\-HLTLog\-Error,     Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )
  43 \item
  44 \#define {\bf HLTFatal}()\ Logging\-Varargs(k\-HLTLog\-Fatal,     Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )
  45 \item
  46 \#define {\bf HLTLog\-Keyword}(a)\ {\bf Ali\-HLTKeyword} hltlog\-Tmpkey\_\-\_\-LINE\_\-\_\-(this, a)
  47 \item
  48 \#define {\bf HLT\_\-DEFAULT\_\-LOG\_\-KEYWORD}\ \char`\"{}no key\char`\"{}
  49 \end{CompactItemize}
  50
  51
  52 \subsection{Define Documentation}
  53 \index{AliHLTLogging.h@{Ali\-HLTLogging.h}!FUNCTIONNAME@{FUNCTIONNAME}}
  54 \index{FUNCTIONNAME@{FUNCTIONNAME}!AliHLTLogging.h@{Ali\-HLTLogging.h}}
  55 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define FUNCTIONNAME()\ \char`\"{}???\char`\"{}}\label{AliHLTLogging_8h_a1}
  56
  57
  58
  59
  60 Definition at line 33 of file Ali\-HLTLogging.h.\index{AliHLTLogging.h@{Ali\-HLTLogging.h}!HLT_DEFAULT_LOG_KEYWORD@{HLT\_\-DEFAULT\_\-LOG\_\-KEYWORD}}
  61 \index{HLT_DEFAULT_LOG_KEYWORD@{HLT\_\-DEFAULT\_\-LOG\_\-KEYWORD}!AliHLTLogging.h@{Ali\-HLTLogging.h}}
  62 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define HLT\_\-DEFAULT\_\-LOG\_\-KEYWORD\ \char`\"{}no key\char`\"{}}\label{AliHLTLogging_8h_a9}
  63
  64
  65
  66
  67 Definition at line 47 of file Ali\-HLTLogging.h.
  68
  69 Referenced by Ali\-HLTConfiguration::Global\-Deinit(), Ali\-HLTConfiguration::Global\-Init(), and Ali\-HLTLogging::Message().\index{AliHLTLogging.h@{Ali\-HLTLogging.h}!HLTBenchmark@{HLTBenchmark}}
  70 \index{HLTBenchmark@{HLTBenchmark}!AliHLTLogging.h@{Ali\-HLTLogging.h}}
  71 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define HLTBenchmark()\ Logging\-Varargs(k\-HLTLog\-Benchmark, Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )}\label{AliHLTLogging_8h_a2}
  72
  73
  74
  75
  76 Definition at line 37 of file Ali\-HLTLogging.h.\index{AliHLTLogging.h@{Ali\-HLTLogging.h}!HLTDebug@{HLTDebug}}
  77 \index{HLTDebug@{HLTDebug}!AliHLTLogging.h@{Ali\-HLTLogging.h}}
  78 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define HLTDebug()\ Logging\-Varargs(k\-HLTLog\-Debug,     Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )}\label{AliHLTLogging_8h_a3}
  79
  80
  81
  82
  83 Definition at line 38 of file Ali\-HLTLogging.h.
  84
  85 Referenced by Ali\-HLTSystem::Build\-Task\-Lists\-From\-Top\-Configurations(), Ali\-HLTComponent\-Handler::Create\-Component(), Ali\-HLTComponent::Create\-Input\-Object(), Ali\-HLTData\-Source::Do\-Processing(), Ali\-HLTComponent::Get\-First\-Input\-Object(), Ali\-HLTSystem::Insert\-Task(), Ali\-HLTSystem::Load\-Configurations(), Ali\-HLTComponent\-Handler::Load\-Library(), Ali\-HLTTask::Process\-Task(), Ali\-HLTSystem::Process\-Tasks(), Ali\-HLTComponent::Push\-Back(), Ali\-HLTComponent\-Handler::Register\-Component(), Ali\-HLTConfiguration\-Handler::Register\-Configuration(), Ali\-HLTConfiguration\-Handler::Remove\-Configuration(), Ali\-HLTData\-Buffer::Set\-Consumer(), Ali\-HLTData\-Buffer::Set\-Segments(), Ali\-HLTTask::Start\-Run(), Ali\-HLTData\-Buffer::Subscribe(), Ali\-HLTComponent\-Handler::Unload\-Library(), and Ali\-HLTConfiguration\-Handler::$\sim$Ali\-HLTConfiguration\-Handler().\index{AliHLTLogging.h@{Ali\-HLTLogging.h}!HLTError@{HLTError}}
  86 \index{HLTError@{HLTError}!AliHLTLogging.h@{Ali\-HLTLogging.h}}
  87 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define HLTError()\ Logging\-Varargs(k\-HLTLog\-Error,     Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )}\label{AliHLTLogging_8h_a6}
  88
  89
  90
  91
  92 Definition at line 41 of file Ali\-HLTLogging.h.
  93
  94 Referenced by Ali\-HLTConfiguration::Ali\-HLTConfiguration(), Ali\-HLTSystem::Build\-Task\-List(), Ali\-HLTSystem::Build\-Task\-Lists\-From\-Top\-Configurations(), Ali\-HLTData\-Buffer::Change\-Consumer\-State(), Class\-Imp(), Ali\-HLTSystem::Configure(), Ali\-HLTComponent\-Handler::Create\-Component(), Ali\-HLTConfiguration\-Handler::Create\-Configuration(), Ali\-HLTComponent::Create\-Input\-Object(), Ali\-HLTConfiguration::Extract\-Sources(), Ali\-HLTSystem::Fill\-ESD(), Ali\-HLTConfiguration::Get\-Arguments(), Ali\-HLTComponent::Get\-Data\-Type(), Ali\-HLTTask::Get\-Nof\-Matching\-Data\-Types(), Ali\-HLTComponent::Get\-Specification(), Ali\-HLTData\-Buffer::Get\-Target\-Buffer(), Ali\-HLTTask::Init(), Ali\-HLTComponent::Init(), Ali\-HLTComponent::Insert\-Output\-Block(), Ali\-HLTSystem::Insert\-Task(), Ali\-HLTSystem::Load\-Configurations(), Ali\-HLTComponent\-Handler::Load\-Library(), Ali\-HLTComponent::Process\-Event(), Ali\-HLTTask::Process\-Task(), Ali\-HLTComponent::Push\-Back(), Ali\-HLTSystem::Reconstruct(), Ali\-HLTData\-Buffer::Release(), Ali\-HLTSystem::Reset(), Ali\-HLTSystem::Run(), Ali\-HLTData\-Buffer::Set\-Consumer(), Ali\-HLTData\-Buffer::Set\-Segments(), Ali\-HLTTask::Start\-Run(), Ali\-HLTData\-Buffer::Subscribe(), and Ali\-HLTComponent\-Handler::Unload\-Library().\index{AliHLTLogging.h@{Ali\-HLTLogging.h}!HLTFatal@{HLTFatal}}
  95 \index{HLTFatal@{HLTFatal}!AliHLTLogging.h@{Ali\-HLTLogging.h}}
  96 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define HLTFatal()\ Logging\-Varargs(k\-HLTLog\-Fatal,     Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )}\label{AliHLTLogging_8h_a7}
  97
  98
  99
 100
 101 Definition at line 42 of file Ali\-HLTLogging.h.
 102
 103 Referenced by Ali\-HLTComponent::Ali\-HLTComponent(), Ali\-HLTComponent\-Handler::Ali\-HLTComponent\-Handler(), Ali\-HLTData\-Buffer::Ali\-HLTData\-Buffer(), Ali\-HLTLogging::Ali\-HLTLogging(), Ali\-HLTOffline\-Data\-Sink::Ali\-HLTOffline\-Data\-Sink(), Ali\-HLTOffline\-Data\-Source::Ali\-HLTOffline\-Data\-Source(), Ali\-HLTSystem::Ali\-HLTSystem(), Ali\-HLTTask::Ali\-HLTTask(), Ali\-HLTComponent::Alloc\-Memory(), Class\-Imp(), Ali\-HLTComponent::Create\-Input\-Object(), Ali\-HLTProcessor::Do\-Event(), Ali\-HLTData\-Sink::Dump\-Event(), Ali\-HLTConfiguration::Extract\-Sources(), Ali\-HLTComponent::Get\-Data\-Type(), Ali\-HLTData\-Source::Get\-Event(), Ali\-HLTComponent::Get\-Input\-Object(), Ali\-HLTTask::Get\-Nof\-Matching\-Data\-Blocks(), Ali\-HLTTask::Get\-Nof\-Matching\-Data\-Types(), Ali\-HLTComponent::Get\-Specification(), Ali\-HLTSystem::Load\-Component\-Libraries(), Ali\-HLTPHOSRaw\-Analyzer\-Peak\-Finder\-Component::Load\-PFVector(), Ali\-HLTSystem::operator=(), Ali\-HLTOffline\-Data\-Source::operator=(), Ali\-HLTOffline\-Data\-Sink::operator=(), Ali\-HLTLogging::operator=(), Ali\-HLTData\-Buffer::operator=(), Ali\-HLTTask::operator=(), Ali\-HLTComponent\-Handler::operator=(), Ali\-HLTComponent::operator=(), Ali\-HLTComponent::Process\-Event(), Ali\-HLTTask::Process\-Task(), Ali\-HLTTask::Release(), Ali\-HLTData\-Buffer::Set\-Segments(), Ali\-HLTTask::Start\-Run(), and Ali\-HLTTask::Subscribe().\index{AliHLTLogging.h@{Ali\-HLTLogging.h}!HLTInfo@{HLTInfo}}
 104 \index{HLTInfo@{HLTInfo}!AliHLTLogging.h@{Ali\-HLTLogging.h}}
 105 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define HLTInfo()\ Logging\-Varargs(k\-HLTLog\-Info,      Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )}\label{AliHLTLogging_8h_a4}
 106
 107
 108
 109
 110 Definition at line 39 of file Ali\-HLTLogging.h.
 111
 112 Referenced by Ali\-HLTComponent\-Handler::Announce\-Version(), Ali\-HLTSystem::Fill\-ESD(), Ali\-HLTComponent\-Handler::List(), Ali\-HLTComponent\-Handler::Load\-Library(), Ali\-HLTSystem::Reconstruct(), Ali\-HLTComponent\-Handler::Register\-Component(), and Ali\-HLTSystem::Run().\index{AliHLTLogging.h@{Ali\-HLTLogging.h}!HLTLogKeyword@{HLTLogKeyword}}
 113 \index{HLTLogKeyword@{HLTLogKeyword}!AliHLTLogging.h@{Ali\-HLTLogging.h}}
 114 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define HLTLog\-Keyword(a)\ {\bf Ali\-HLTKeyword} hltlog\-Tmpkey\_\-\_\-LINE\_\-\_\-(this, a)}\label{AliHLTLogging_8h_a8}
 115
 116
 117
 118
 119 Definition at line 45 of file Ali\-HLTLogging.h.
 120
 121 Referenced by Ali\-HLTConfiguration\-Handler::Print\-Configurations(), Ali\-HLTTask::Print\-Dependency\-Tree(), Ali\-HLTTask::Print\-Status(), Ali\-HLTConfiguration::Print\-Status(), and Ali\-HLTSystem::Print\-Task\-List().\index{AliHLTLogging.h@{Ali\-HLTLogging.h}!HLTMessage@{HLTMessage}}
 122 \index{HLTMessage@{HLTMessage}!AliHLTLogging.h@{Ali\-HLTLogging.h}}
 123 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define HLTMessage()\ Logging\-Varargs(k\-HLTLog\-None,      NULL , NULL , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )}\label{AliHLTLogging_8h_a0}
 124
 125
 126
 127
 128 Definition at line 27 of file Ali\-HLTLogging.h.
 129
 130 Referenced by Ali\-HLTConfiguration\-Handler::Print\-Configurations(), Ali\-HLTComponent::Print\-Data\-Type\-Content(), Ali\-HLTTask::Print\-Dependency\-Tree(), Ali\-HLTTask::Print\-Status(), Ali\-HLTConfiguration::Print\-Status(), and Ali\-HLTSystem::Print\-Task\-List().\index{AliHLTLogging.h@{Ali\-HLTLogging.h}!HLTWarning@{HLTWarning}}
 131 \index{HLTWarning@{HLTWarning}!AliHLTLogging.h@{Ali\-HLTLogging.h}}
 132 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define HLTWarning()\ Logging\-Varargs(k\-HLTLog\-Warning,   Class\_\-Name() , FUNCTIONNAME() , \_\-\_\-FILE\_\-\_\- , \_\-\_\-LINE\_\-\_\- , \_\-\_\-VA\_\-ARGS\_\-\_\- )}\label{AliHLTLogging_8h_a5}
 133
 134
 135
 136
 137 Definition at line 40 of file Ali\-HLTLogging.h.
 138
 139 Referenced by Ali\-HLTSystem::Ali\-HLTSystem(), Ali\-HLTSystem::Build\-Task\-Lists\-From\-Top\-Configurations(), Class\-Imp(), Ali\-HLTComponent\-Handler::Create\-Component(), Ali\-HLTComponent::Create\-Event\-Done\-Data(), Ali\-HLTTask::Deinit(), Ali\-HLTComponent\-Handler::Deregister\-Component(), Ali\-HLTData\-Source::Do\-Processing(), Ali\-HLTTask::End\-Run(), Ali\-HLTTask::Init(), Ali\-HLTSystem::Init\-Benchmarking(), Ali\-HLTSystem::Init\-Tasks(), Ali\-HLTConfiguration\-Handler::Register\-Configuration(), Ali\-HLTData\-Buffer::Release(), Ali\-HLTConfiguration\-Handler::Remove\-Configuration(), Ali\-HLTData\-Buffer::Reset\-Data\-Buffer(), Ali\-HLTData\-Buffer::Set\-Consumer(), Ali\-HLTComponent::Set\-Data\-Type(), Ali\-HLTComponent::Set\-Stopwatch(), Ali\-HLTTask::Start\-Run(), and Ali\-HLTComponent\-Handler::Unload\-Library().