PLMD::cltools::GenExample Class Reference

Inheritance diagram for PLMD::cltools::GenExample:

Public Types
enum	{ unset, commandline, ifile }
	How is the input specified on the command line or in an input file. More...

Public Member Functions
	GenExample (const CLToolOptions &co)
std::vector< std::vector< std::string > >	createLongInput (const std::vector< std::vector< std::string > > &input)
std::string	description () const override
	virtual function returning a one-line descriptor for the tool More...
const std::map< std::string, std::string > &	getInputData ()
int	main (FILE *in, FILE *out, Communicator &pc) override
	virtual function mapping to the specific main for each tool More...
void	printExampleInput (const std::vector< std::vector< std::string > > &input, const std::string &egname, const std::string &divname, std::ofstream &ofile)
bool	readInput (int argc, char **argv, FILE *in, FILE *out)
	Read the arguments from the command line. More...
void	setInputData (const std::map< std::string, std::string > &inputData)
	Set the input data: More...

Static Public Member Functions
static void	registerKeywords (Keywords &keys)

Public Attributes
enum PLMD::CLTool:: { ... }	inputdata
	How is the input specified on the command line or in an input file. More...

Protected Member Functions
void	error (const std::string &msg)
	Crash the command line tool with an error. More...
template<class T >
bool	parse (const std::string &key, T &t)
	Get the value of one of the command line arguments. More...
void	parseFlag (const std::string &key, bool &t)
	Find out whether one of the command line flags is present or not. More...
template<class T >
bool	parseVector (const std::string &key, std::vector< T > &t)

Private Member Functions
bool	readCommandLineArgs (int argc, char **argv, FILE *out)
	Read the arguments from the command line. More...
bool	readInputFile (int argc, char **argv, FILE *in, FILE *out)
	Read the arguments from an input file specified on the command line. More...
void	setRemainingToDefault (FILE *out)
	Set arguments from the default options provided to Keywords. More...

Private Attributes
std::map< std::string, std::string >	inputData
	The data read in from the command line stored in a map with the keywords. More...
Communicator	intercomm
Communicator	intracomm
const Keywords &	keywords
	The list of keywords for this CLTool. More...
int	multi
const std::string	name
	The name of this command line tool. More...
std::string	status
std::string	version

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

How is the input specified on the command line or in an input file.

Enumerator
unset
commandline
ifile

Constructor & Destructor Documentation

GenExample()

PLMD::cltools::GenExample::GenExample ( const CLToolOptions &  co )

explicit

Member Function Documentation

createLongInput()

std::vector< std::vector< std::string > > PLMD::cltools::GenExample::createLongInput

(

const std::vector< std::vector< std::string > > &

input

)

description()

std::string PLMD::cltools::GenExample::description ( ) const

inlineoverridevirtual

virtual function returning a one-line descriptor for the tool

Reimplemented from PLMD::CLTool.

error()

void PLMD::CLTool::error ( const std::string &  msg )

protectedinherited

Crash the command line tool with an error.

getInputData()

const std::map<std::string,std::string>& PLMD::CLTool::getInputData ( )

inlineinherited

main()

int PLMD::cltools::GenExample::main ( FILE *  in, FILE *  out, Communicator &  pc  )

overridevirtual

virtual function mapping to the specific main for each tool

Implements PLMD::CLTool.

parse()

template<class T >

bool PLMD::CLTool::parse ( const std::string &  key, T &  t  )

protectedinherited

Get the value of one of the command line arguments.

parseFlag()

void PLMD::CLTool::parseFlag ( const std::string &  key, bool &  t  )

protectedinherited

Find out whether one of the command line flags is present or not.

parseVector()

template<class T >

bool PLMD::CLTool::parseVector ( const std::string &  key, std::vector< T > &  t  )

protectedinherited

printExampleInput()

void PLMD::cltools::GenExample::printExampleInput	(	const std::vector< std::vector< std::string > > &	input,
		const std::string &	egname,
		const std::string &	divname,
		std::ofstream &	ofile
	)

readCommandLineArgs()

bool PLMD::CLTool::readCommandLineArgs ( int  argc, char **  argv, FILE *  out  )

privateinherited

Read the arguments from the command line.

readInput()

bool PLMD::CLTool::readInput ( int  argc, char **  argv, FILE *  in, FILE *  out  )

inherited

Read the arguments from the command line.

readInputFile()

bool PLMD::CLTool::readInputFile ( int  argc, char **  argv, FILE *  in, FILE *  out  )

privateinherited

Read the arguments from an input file specified on the command line.

registerKeywords()

void PLMD::cltools::GenExample::registerKeywords ( Keywords &  keys )

static

setInputData()

void PLMD::CLTool::setInputData ( const std::map< std::string, std::string > &  inputData )

inlineinherited

Set the input data:

setRemainingToDefault()

void PLMD::CLTool::setRemainingToDefault ( FILE *  out )

privateinherited

Set arguments from the default options provided to Keywords.

Member Data Documentation

inputData

std::map<std::string,std::string> PLMD::CLTool::inputData

privateinherited

The data read in from the command line stored in a map with the keywords.

inputdata

enum { ... } PLMD::CLTool::inputdata

How is the input specified on the command line or in an input file.

intercomm

Communicator PLMD::cltools::GenExample::intercomm

private

intracomm

Communicator PLMD::cltools::GenExample::intracomm

private

keywords

const Keywords& PLMD::CLTool::keywords

privateinherited

The list of keywords for this CLTool.

multi

int PLMD::cltools::GenExample::multi

private

name

const std::string PLMD::CLTool::name

privateinherited

The name of this command line tool.

status

std::string PLMD::cltools::GenExample::status

private

version

std::string PLMD::cltools::GenExample::version

private

---

The documentation for this class was generated from the following file:

• cltools/GenExample.cpp