#include <BEMGeneratorCmdLineOptions.hh>

Inheritance diagram for BEMGeneratorCmdLineOptions:

Collaboration diagram for BEMGeneratorCmdLineOptions:

Public Member Functions
	BEMGeneratorCmdLineOptions ()

virtual	~BEMGeneratorCmdLineOptions ()

std::string	adfFile () const

std::string	outputFile () const

virtual void	printVersion () const

virtual void	printHelp () const

Public Member Functions inherited from CmdLineOptions
	CmdLineOptions (std::string description, std::string version="")

virtual	~CmdLineOptions ()

void	parse (char *argv[], int argc)

void	parse (std::string argv[], int argc)

void	parse (std::vector< std::string > argv)

virtual bool	isVerboseSwitchDefined () const

virtual bool	isVerboseSpamSwitchDefined () const

Public Member Functions inherited from CmdLineParser
	CmdLineParser (std::string description)

virtual	~CmdLineParser ()

virtual void	storeOptions (Options &options)

virtual int	numberOfArguments () const

virtual std::string	argument (int index) const

Static Private Attributes
static const std::string	ADF_PARAM_NAME = "adf"
	Long name of the ADF file parameter.

static const std::string	OUTPUT_FILE_PARAM_NAME
	Long name of the output file parameter.

Additional Inherited Members
Protected Member Functions inherited from CmdLineOptions
bool	optionGiven (std::string key) const

Protected Member Functions inherited from CmdLineParser
void	addOption (CmdLineOptionParser *opt)

CmdLineOptionParser *	findOption (std::string name) const

bool	parseOption (std::string option, std::string &name, std::string &arguments, std::string &prefix, bool &hasArgument) const

bool	readPrefix (std::string &option, std::string &prefix, bool &longOption) const

bool	isPrefix (std::string name) const

Protected Attributes inherited from CmdLineParser
std::map< std::string, CmdLineOptionParser * >	optionLongNames_
	Database for holding options with their long names as a key.

std::map< std::string, CmdLineOptionParser * >	optionShortNames_
	Database for holding options with their short names as a key.

std::vector< std::string >	commandLine_
	Command line is stored here.

std::vector< std::string >	arguments_
	Command line arguments are stored here.

std::vector< std::string >	prefixes_
	Legal prefixes are stored here.

Detailed Description

Command line options for the command line interface of bem generator (createbem).

Definition at line 42 of file BEMGeneratorCmdLineOptions.hh.

Constructor & Destructor Documentation

◆ BEMGeneratorCmdLineOptions()

BEMGeneratorCmdLineOptions::BEMGeneratorCmdLineOptions ( )

The constructor.

Definition at line 43 of file BEMGeneratorCmdLineOptions.cc.

                                                       : 
    CmdLineOptions("") {
 
    StringCmdLineOptionParser* outputFile = new StringCmdLineOptionParser(
        OUTPUT_FILE_PARAM_NAME, "The name of the output file", "o");
    addOption(outputFile);
}

References CmdLineParser::addOption(), OUTPUT_FILE_PARAM_NAME, and outputFile().

Here is the call graph for this function:

◆ ~BEMGeneratorCmdLineOptions()

BEMGeneratorCmdLineOptions::~BEMGeneratorCmdLineOptions ( )

virtual

The destructor.

Definition at line 55 of file BEMGeneratorCmdLineOptions.cc.

55 {

56}

Member Function Documentation

◆ adfFile()

std::string BEMGeneratorCmdLineOptions::adfFile ( ) const

Returns the name of the ADF file given as command line parameter.

Returns: The name of the ADF file.

Definition at line 65 of file BEMGeneratorCmdLineOptions.cc.

                                          {
    if (numberOfArguments() < 1) {
        return "";
    } else {
        return argument(numberOfArguments());
    }
}

References CmdLineParser::argument(), and CmdLineParser::numberOfArguments().

Here is the call graph for this function:

◆ outputFile()

std::string BEMGeneratorCmdLineOptions::outputFile ( ) const

Returns the name of the output file given as command line parameter.

Returns: The name of the output file.

Definition at line 80 of file BEMGeneratorCmdLineOptions.cc.

                                             {
    return findOption(OUTPUT_FILE_PARAM_NAME)->String();
}

References CmdLineParser::findOption(), OUTPUT_FILE_PARAM_NAME, and CmdLineOptionParser::String().

Referenced by BEMGeneratorCmdLineOptions().

Here is the call graph for this function:

◆ printHelp()

void BEMGeneratorCmdLineOptions::printHelp ( ) const

virtual

Prints the help.

Reimplemented from CmdLineOptions.

Definition at line 105 of file BEMGeneratorCmdLineOptions.cc.

                                            {
    printVersion();
    std::cout << "Usage: createbem [OPTION] <ADF File>";
    CmdLineOptions::printHelp();
}

References CmdLineOptions::printHelp(), and printVersion().

Here is the call graph for this function:

◆ printVersion()

void BEMGeneratorCmdLineOptions::printVersion ( ) const

virtual

Prints the version of the user interface.

Implements CmdLineOptions.

Definition at line 89 of file BEMGeneratorCmdLineOptions.cc.

                                               {
    BEMGeneratorCLITextGenerator textGenerator;
    std::cout 
        << textGenerator.text(BEMGeneratorCLITextGenerator::TXT_CLI_TITLE).
        str() 
        << " " 
        << textGenerator.text(
            BEMGeneratorCLITextGenerator::TXT_CLI_VERSION).str() 
        << std::endl;
}

References Texts::TextGenerator::text(), BEMGeneratorCLITextGenerator::TXT_CLI_TITLE, and BEMGeneratorCLITextGenerator::TXT_CLI_VERSION.

Referenced by printHelp().

Here is the call graph for this function:

Member Data Documentation

◆ ADF_PARAM_NAME

const std::string BEMGeneratorCmdLineOptions::ADF_PARAM_NAME = "adf"

staticprivate

Long name of the ADF file parameter.

Definition at line 54 of file BEMGeneratorCmdLineOptions.hh.

◆ OUTPUT_FILE_PARAM_NAME

const std::string BEMGeneratorCmdLineOptions::OUTPUT_FILE_PARAM_NAME

staticprivate

Initial value:

=

"output"

Long name of the output file parameter.

Definition at line 56 of file BEMGeneratorCmdLineOptions.hh.

Referenced by BEMGeneratorCmdLineOptions(), and outputFile().

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

Public Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BEMGeneratorCmdLineOptions()

◆ ~BEMGeneratorCmdLineOptions()

Member Function Documentation

◆ adfFile()

◆ outputFile()

◆ printHelp()

◆ printVersion()

Member Data Documentation

◆ ADF_PARAM_NAME

◆ OUTPUT_FILE_PARAM_NAME