#include <ESTAnalyzerFactory.h>
Static Public Member Functions | |
| static ESTAnalyzer * | create (const char *name, const int refESTidx, const std::string &outputFileName) |
| Method to instantiate a suitable EST Analyzer. | |
| static void | displayList (std::ostream &os) |
| Method to display the list of EST analyzers available. | |
Private Member Functions | |
| ESTAnalyzerFactory () | |
| The default constructor. | |
| ~ESTAnalyzerFactory () | |
| The destructor. | |
Definition at line 42 of file ESTAnalyzerFactory.h.
| ESTAnalyzerFactory::ESTAnalyzerFactory | ( | ) | [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 EST analyzerw.
Definition at line 90 of file ESTAnalyzerFactory.h.
| ESTAnalyzerFactory::~ESTAnalyzerFactory | ( | ) | [inline, private] |
The destructor.
The destructor is private to ensure that objects of this class are never deleted.
Definition at line 97 of file ESTAnalyzerFactory.h.
| ESTAnalyzer * ESTAnalyzerFactory::create | ( | const char * | name, | |
| const int | refESTidx, | |||
| const std::string & | outputFileName | |||
| ) | [static] |
Method to instantiate a suitable EST Analyzer.
This method must be used to instantiate a suitable EST analyzer instance. This method uses the name (parameter) to suitably instantiate an EST analyzer. If the name is not valid, then this method returns NULL.
| [in] | name | The name of the EST analyzer to be instantiated. |
| [in] | refESTidx | The reference EST index value to be used when instantiating an EST analyzer. 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 EST analyzer is used to generate clusters. If the value of outputFileName is "" (empty string) then the outputs are streamed to standard out. |
Definition at line 73 of file ESTAnalyzerFactory.cpp.
Referenced by main().
| void ESTAnalyzerFactory::displayList | ( | std::ostream & | os | ) | [static] |
Method to display the list of EST analyzers available.
This method is typically used to display the list of EST analyzers 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 EST names must be written. |
Definition at line 48 of file ESTAnalyzerFactory.cpp.
References arg_parser::BOOLEAN, and arg_parser::STRING.
Referenced by showUsage().
1.6.1