Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
PLMD::CLTool Class Referenceabstract


This is the abstract base class to use for implementing new command line tool, within it there is information as to how to go about implemneting a new tool. More...

#include <CLTool.h>

Inheritance diagram for PLMD::CLTool:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

void setInputData (const std::map< std::string, std::string > &inputData)
 Set the input data: More...
 
const std::map< std::string, std::string > & getInputData ()
 
 CLTool (const CLToolOptions &co)
 
bool readInput (int argc, char **argv, FILE *in, FILE *out)
 Read the arguments from the command line. More...
 
virtual int main (FILE *in, FILE *out, Communicator &pc)=0
 virtual function mapping to the specific main for each tool More...
 
virtual std::string description () const
 virtual function returning a one-line descriptor for the tool More...
 
virtual ~CLTool ()
 virtual destructor to allow inheritance More...
 

Static Public Member Functions

static void registerKeywords (Keywords &keys)
 Create the help keywords. More...
 

Public Attributes

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

Protected Member Functions

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...
 
void error (const std::string &msg)
 Crash the command line tool with an error. 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

const std::string name
 The name of this command line tool. More...
 
const Keywordskeywords
 The list of keywords for this CLTool. More...
 
std::map< std::string, std::string > inputData
 The data read in from the command line stored in a map with the keywords. More...
 

Detailed Description


This is the abstract base class to use for implementing new command line tool, within it there is information as to how to go about implemneting a new tool.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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

Enumerator
unset 
commandline 
ifile 

Constructor & Destructor Documentation

◆ CLTool()

PLMD::CLTool::CLTool ( const CLToolOptions co)
explicit

◆ ~CLTool()

virtual PLMD::CLTool::~CLTool ( )
inlinevirtual

virtual destructor to allow inheritance

Member Function Documentation

◆ description()

virtual std::string PLMD::CLTool::description ( ) const
inlinevirtual

◆ error()

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

Crash the command line tool with an error.

◆ getInputData()

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

◆ main()

virtual int PLMD::CLTool::main ( FILE *  in,
FILE *  out,
Communicator pc 
)
pure virtual

◆ parse()

template<class T >
bool PLMD::CLTool::parse ( const std::string &  key,
T &  t 
)
protected

Get the value of one of the command line arguments.

◆ parseFlag()

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

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 
)
protected

◆ readCommandLineArgs()

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

Read the arguments from the command line.

◆ readInput()

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

Read the arguments from the command line.

◆ readInputFile()

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

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

◆ registerKeywords()

void PLMD::CLTool::registerKeywords ( Keywords keys)
static

Create the help keywords.

◆ setInputData()

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

Set the input data:

◆ setRemainingToDefault()

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

Set arguments from the default options provided to Keywords.

Member Data Documentation

◆ inputData

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

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.

◆ keywords

const Keywords& PLMD::CLTool::keywords
private

The list of keywords for this CLTool.

◆ name

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

The name of this command line tool.


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