minor corrections in documentation and build system, bugfix in agent to return config...
[u/mrichter/AliRoot.git] / HLT / BASE / util / AliHLTAgentUtil.h
CommitLineData
242bb794 1// @(#) $Id$
2
3#ifndef ALIHLTAGENTUTIL_H
4#define ALIHLTAGENTUTIL_H
5/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
6 * See cxx source for full Copyright notice */
7
8/** @file AliHLTAgentUtil.h
9 @author Matthias Richter
10 @date
11 @brief Agent of the libAliHLTUtil library
12*/
13
14#include "AliHLTModuleAgent.h"
15
16/**
17 * @class AliHLTAgentUtil
18 * This is the agent for the AliHLTUtil library.
19 *
20 * @ingroup alihlt_system
21 */
22class AliHLTAgentUtil : public AliHLTModuleAgent {
23 public:
24 /**
25 * standard constructor. The agent is automatically registered in the
26 * global agent manager
27 */
28 AliHLTAgentUtil();
29 /** destructor */
30 virtual ~AliHLTAgentUtil();
31
32 /**
33 * Register all configurations belonging to this module with the
34 * AliHLTConfigurationHandler. The agent can adapt the configurations
35 * to be registered to the current AliRoot setup by checking the
36 * runloader.
96bda103 37 * @param handler the configuration handler
242bb794 38 * @param runloader AliRoot runloader
39 * @return neg. error code if failed
40 */
41 int CreateConfigurations(AliHLTConfigurationHandler* handler,
42 AliRunLoader* runloader=NULL) const;
43
44 /**
45 * Get the top configurations belonging to this module.
46 * A top configuration describes a processing chain. It can simply be
47 * described by the last configuration(s) in the chain.
48 * The agent can adapt the configurations to be registered to the current
49 * AliRoot setup by checking the runloader.
50 * @param runloader AliRoot runloader
51 * @return number of configurations, neg. error code if failed
52 */
56951e49 53 const char* GetLocalRecConfigurations(AliRunLoader* runloader=NULL) const;
242bb794 54
55 /**
56 * Component libraries which the configurations of this agent depend on.
57 * @return list of component libraries as a blank-separated string.
58 */
59 const char* GetRequiredComponentLibraries() const;
60
61 protected:
62
63 private:
64 ClassDef(AliHLTAgentUtil, 0);
65};
66
67#endif