// @(#) $Id$ #ifndef ALIHLTAGENTSAMPLE_H #define ALIHLTAGENTSAMPLE_H /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * * See cxx source for full Copyright notice */ /** @file AliHLTAgentSample.h @author Matthias Richter @date @brief Agent of the libAliHLTSample library */ #include "AliHLTModuleAgent.h" /** * @class AliHLTAgentSample * This is the agent for the AliHLTSample library.
* The AliHLTSample library illustrates usage of the HLT framework. The * agent provides information on the features of the sample components * and the configuration which should be run during AliRoot reconstruction. * * The sample agent implements all interface function provided by @ref * AliHLTModuleAgent : * - @ref CreateConfigurations
* The method gets an instance of the AliHLTConfigurationHanler to add * configurations, e.g. *
 *   handler->CreateConfiguration("my-puplisher"  , "FilePublisher", NULL , "data.bin");
 *   ...
 *   handler->CreateConfiguration("my-analysis-chain"  , "FileWriter", "my-processor" , "my arguments");
 *   
* - @ref GetLocalRecConfigurations
* returns a string of blank separated configurations to be run during * local event reconstruction. *
 *   return "my-data-sink my-analysis-chain";
 *   
* - @ref GetRequiredComponentLibraries
* returns a string of blank separated libraries which have to be loaded * in addition *
 *   return "libAliHLTUtil.so";
 *   
* - not implemented are the in iterface methods * - @ref AliHLTModuleAgent::GetEventRecConfigurations * - @ref AliHLTModuleAgent::RegisterComponents * * In order to hook the sample library up to the HLT system on global object * @ref gAliHLTAgentSample of the agent is defined in the source code. * * @ingroup alihlt_system */ class AliHLTAgentSample : public AliHLTModuleAgent { public: /** * standard constructor. The agent is automatically registered in the * global agent manager */ AliHLTAgentSample(); /** destructor */ virtual ~AliHLTAgentSample(); /** * Register all configurations belonging to the sample library with the * AliHLTConfigurationHandler. The agent can adapt the configurations * to be registered to the current AliRoot setup by checking the * runloader. * @param handler the configuration handler * @param runloader AliRoot runloader * @return neg. error code if failed */ int CreateConfigurations(AliHLTConfigurationHandler* handler, AliRunLoader* runloader=NULL) const; /** * Get the top configurations for local event reconstruction. * A top configuration describes a processing chain. It can simply be * described by the last configuration(s) in the chain. * The agent can adapt the configurations to be registered to the current * AliRoot setup by checking the runloader. * @param runloader [in] AliRoot runloader * @return string containing the top configurations separated by blanks */ const char* GetLocalRecConfigurations(AliRunLoader* runloader=NULL) const; /** * Component libraries which the configurations of this agent depend on. * @return list of component libraries as a blank-separated string. */ const char* GetRequiredComponentLibraries() const; protected: private: /** file name of the generated test data*/ static const char* fgkAliHLTAgentSampleData; //!transient /** file name of the output file */ static const char* fgkAliHLTAgentSampleOut; //!transient /** ROOT specific member definition */ ClassDef(AliHLTAgentSample, 1); }; #endif