#include <ClusterMakerFactory.h>
Static Public Member Functions | |
| static ClusterMaker * | create (const char *name, ESTAnalyzer *analyzer, const int refESTidx, const std::string &outputFileName) |
| Method to instantiate a suitable Cluster Maker object. | |
| static void | displayList (std::ostream &os) |
| Method to display the list of cluster makers available. | |
Private Member Functions | |
| ClusterMakerFactory () | |
| The default constructor. | |
| ~ClusterMakerFactory () | |
| The destructor. | |
Definition at line 43 of file ClusterMakerFactory.h.
| ClusterMakerFactory::ClusterMakerFactory | ( | ) | [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 cluster maker.
Definition at line 97 of file ClusterMakerFactory.h.
| ClusterMakerFactory::~ClusterMakerFactory | ( | ) | [inline, private] |
The destructor.
The destructor is private to ensure that objects of this class are never deleted.
Definition at line 104 of file ClusterMakerFactory.h.
| ClusterMaker * ClusterMakerFactory::create | ( | const char * | name, | |
| ESTAnalyzer * | analyzer, | |||
| const int | refESTidx, | |||
| const std::string & | outputFileName | |||
| ) | [static] |
Method to instantiate a suitable Cluster Maker object.
This method must be used to instantiate a suitable cluster maker instance. This method uses the name (parameter) to suitably instantiate an cluster maker. If the name is not valid, then this method returns NULL.
| [in] | name | The name of the cluster maker to be instantiated. |
| [in,out] | analyzer | The EST analyzer to be used by this ClusterMaker for generating similarity metrics between two given ESTs. If this parameter is NULL, this method prints an error message and returns NULL. |
| [in] | refESTidx | The reference EST index value to be used when instantiating a cluster maker. 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). If this parameter is the empty string (""), then the output is written to standard output. |
Definition at line 60 of file ClusterMakerFactory.cpp.
Referenced by main().
| void ClusterMakerFactory::displayList | ( | std::ostream & | os | ) | [static] |
Method to display the list of cluster makers available.
This method is typically used to display the list of cluster makers currently compiled into the program. 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 45 of file ClusterMakerFactory.cpp.
References arg_parser::BOOLEAN, and arg_parser::STRING.
Referenced by showUsage().
1.6.1