#include <HeuristicFactory.h>
Static Public Member Functions | |
| static Heuristic * | create (const char *name, const int refESTidx, const std::string &outputFileName) |
| Method to instantiate a suitable heuristic. | |
| static void | displayList (std::ostream &os) |
| Method to display the list of heuristics available. | |
Private Member Functions | |
| HeuristicFactory () | |
| The default constructor. | |
| ~HeuristicFactory () | |
| The destructor. | |
Definition at line 42 of file HeuristicFactory.h.
| HeuristicFactory::HeuristicFactory | ( | ) | [inline, private] |
The default constructor.
The default constructor has is private in order to ensure that this class is never instantiated. Instead, the static methods in this class must be directly used to instantiate a heuristic.
Definition at line 88 of file HeuristicFactory.h.
| HeuristicFactory::~HeuristicFactory | ( | ) | [inline, private] |
The destructor.
The destructor is private to ensure that objects of this class are never deleted.
Definition at line 95 of file HeuristicFactory.h.
| Heuristic * HeuristicFactory::create | ( | const char * | name, | |
| const int | refESTidx, | |||
| const std::string & | outputFileName | |||
| ) | [static] |
Method to instantiate a suitable heuristic.
This method must be used to instantiate a suitable heuristic instance. This method uses the name (parameter) to suitably instantiate a heuristic. If the name is not valid, then this method returns NULL.
| [in] | name | The name of the heuristic to be instantiated. |
| [in] | refESTidx | The reference EST index value to be used when instantiating a heuristic. Index values start from 0 (zero). If this value is negative then this method returns NULL. |
| [in] | outputFileName | The target file to which the analysis report is to be written (if any). Note that this parameter may be ignored if this heuristic is used to generate clusters. If the value of outputFileName is "" (empty string) then the outputs are streamed to standard out. |
Definition at line 58 of file HeuristicFactory.cpp.
Referenced by HeuristicChain::setupChain().
| void HeuristicFactory::displayList | ( | std::ostream & | os | ) | [static] |
Method to display the list of heuristics available.
This method is typically used to display the list of heuristics currently available. This method is typically used in the main() method when displaying usage information.
| [out] | os | The output stream to which the list of heuristic names must be written. |
Definition at line 43 of file HeuristicFactory.cpp.
References arg_parser::BOOLEAN, and arg_parser::STRING.
Referenced by showUsage().
1.6.1