Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
PLMD::cltools::Info Class Reference
Inheritance diagram for PLMD::cltools::Info:
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

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

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)
 

Member Enumeration Documentation

anonymous enum
inherited

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

Enumerator
unset 
commandline 
ifile 

Constructor & Destructor Documentation

PLMD::cltools::Info::Info ( const CLToolOptions co)
explicit

Member Function Documentation

string PLMD::cltools::Info::description ( ) const
inlinevirtual

virtual function returning a one-line descriptor for the tool

Reimplemented from PLMD::CLTool.

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

Crash the command line tool with an error.

const std::map<std::string,std::string>& PLMD::CLTool::getInputData ( )
inlineinherited
int PLMD::cltools::Info::main ( FILE *  in,
FILE *  out,
Communicator pc 
)
virtual

virtual function mapping to the specific main for each tool

Implements PLMD::CLTool.

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

Get the value of one of the command line arguments.

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

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

template<class T >
bool PLMD::CLTool::parseVector ( const std::string &  key,
std::vector< T > &  t 
)
protectedinherited
bool PLMD::CLTool::readInput ( int  argc,
char **  argv,
FILE *  in,
FILE *  out 
)
inherited

Read the arguments from the command line.

void PLMD::cltools::Info::registerKeywords ( Keywords keys)
static
void PLMD::CLTool::setInputData ( const std::map< std::string, std::string > &  inputData)
inlineinherited

Set the input data:

Member Data Documentation

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

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


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