main.cpp File Reference

#include "arg_parser.h"
#include "ClusterMakerFactory.h"
#include "ESTAnalyzerFactory.h"
#include "ClusterMaker.h"
#include "ESTAnalyzer.h"
#include "HeuristicFactory.h"
#include "HeuristicChain.h"
#include "FilterFactory.h"
#include "FilterChain.h"
#include "ParameterSetManager.h"
#include "MPIHelper.h"
#include "InteractiveConsole.h"
#include "EST.h"
#include <string>
#include <sstream>
#include <fstream>

Include dependency graph for main.cpp:

Go to the source code of this file.

Functions
static void	showUsage (arg_parser &ap, ESTAnalyzer *analyzer, ClusterMaker *cMaker, HeuristicChain *hChain, FilterChain *fChain)
	A simple helper method to show usage and clean up the temporarily created EST analyzer and cluster Maker objects.
int	applyFilters (ClusterMaker *clusterMaker, FilterChain *chain, const char *filterPassFileName, const char *filterFailFileName)
	Helper method to apply filters (if any).
int	main (int argc, char *argv[])
	The main function that launches all the activites.

---

Function Documentation

int applyFilters	(	ClusterMaker *	clusterMaker,
		FilterChain *	chain,
		const char *	filterPassFileName,
		const char *	filterFailFileName
	)

Helper method to apply filters (if any).

This method is a helper method that is invoked from the main method to apply any filters that the user has sepecified to the list of ESTs (before they are actually clustered).

Returns:

This method returns 0 (zero) on success. On errors or if further clustering is not to be performed, then this method returns a non-zero value.

Definition at line 129 of file main.cpp.

References FilterChain::applyFilters(), EST::dumpESTList(), and MPI_GET_RANK.

Referenced by main().

int main	(	int	argc,
		char *	argv[]
	)

The main function that launches all the activites.

The global main method for the ESTAnalyzer software. The main method performs the task of identifying and creating a specific ESTAnalyzer. Accordingly, it only consumes the "--analyzer" option which is typically the first option specified. However, it is not required that --analyzer be the first option.

Once a specific EST Analyzer has been instantiated the main method simply passes control over to that EST Analyzer.

Definition at line 188 of file main.cpp.

References ESTAnalyzer::analyze(), applyFilters(), arg_parser::BOOLEAN, arg_parser::check_args(), ClusterMakerFactory::create(), ESTAnalyzerFactory::create(), ClusterMaker::initialize(), arg_parser::INTEGER, ClusterMaker::makeClusters(), MPI_FINALIZE, MPI_GET_RANK, MPI_INIT, FilterChain::parseArguments(), HeuristicChain::parseArguments(), ClusterMaker::parseArguments(), ESTAnalyzer::parseArguments(), FilterChain::printStats(), HeuristicChain::printStats(), InteractiveConsole::processCommands(), arg_parser::set_global_args(), ESTAnalyzer::setHeuristicChain(), FilterChain::setupChain(), HeuristicChain::setupChain(), ParameterSetManager::setupParameters(), showUsage(), and arg_parser::STRING.

void showUsage	(	arg_parser &	ap,
		ESTAnalyzer *	analyzer,
		ClusterMaker *	cMaker,
		HeuristicChain *	hChain,
		FilterChain *	fChain
	)			[static]

A simple helper method to show usage and clean up the temporarily created EST analyzer and cluster Maker objects.

Note:

This method is meant to be in local scope rather than global scope.

Parameters:

[in]	ap	The argument parser to be used for displaying common global options.
[in]	analyzer	The EST analyzer (if any) that was created and must now be deleted after showing usage. If this pointer is NULL, then this parameter is ignored.
[in]	cMaker	The cluster Maker (if any) that was created and must now be deleted after showing usage. If this pointer is NULL, then this parameter is ignored.
[in]	hChain	The chain of heuristics that are currently defined for this run.
[in]	fChain	The chain of filters that are currently defined for this run.

Definition at line 80 of file main.cpp.

References FilterFactory::displayList(), HeuristicFactory::displayList(), ClusterMakerFactory::displayList(), ESTAnalyzerFactory::displayList(), FilterChain::showArguments(), HeuristicChain::showArguments(), ClusterMaker::showArguments(), and ESTAnalyzer::showArguments().

Referenced by main().