include/Templates/TemplateAlgorithmTool.h

0001 /**
0002  *  @file   PandoraSDK/include/Templates/TemplateAlgorithmTool.h
0003  *
0004  *  @brief  Header file for the template algorithm tool class.
0005  *
0006  *  $Log: $
0007  */
0008 #ifndef TEMPLATE_ALGORITHM_TOOL_H
0009 #define TEMPLATE_ALGORITHM_TOOL_H 1
0010
0011 #include "Pandora/AlgorithmTool.h"
0012
0013 /**
0014  *  @brief  TemplateAlgorithmTool class
0015  */
0016 class TemplateAlgorithmTool : public pandora::AlgorithmTool
0017 {
0018 public:
0019     /**
0020      *  @brief  Factory class for instantiating algorithm tool
0021      */
0022     class Factory : public pandora::AlgorithmToolFactory
0023     {
0024     public:
0025         pandora::AlgorithmTool *CreateAlgorithmTool() const;
0026     };
0027
0028     /**
0029      *  @brief  Run the algorithm tool
0030      */
0031     pandora::StatusCode Run();
0032
0033 private:
0034     pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);
0035
0036     // Member variables here
0037 };
0038
0039 //------------------------------------------------------------------------------------------------------------------------------------------
0040
0041 inline pandora::AlgorithmTool *TemplateAlgorithmTool::Factory::CreateAlgorithmTool() const
0042 {
0043     return new TemplateAlgorithmTool();
0044 }
0045
0046 #endif // #ifndef TEMPLATE_ALGORITHM_TOOL_H