Command-line option with a single letter, full name and description plus an associated Geant4 command (which is optional). More...

#include <CommandLineOption.hh>

Public Member Functions
	CommandLineOption (const std::string &shortname, const std::string &longname, const std::string &description, unsigned int minArgs=0, unsigned int maxArgs=0, const std::string &macroCommand="")

virtual	~CommandLineOption ()

const std::string &	getDescription () const

const std::string &	getG4CommandString () const

const std::string &	getLongName () const

unsigned int	getMaxArgs () const

unsigned int	getMinArgs () const

const std::string &	getShortName () const

Private Attributes
std::string	m_description

std::string	m_g4cmdstr

std::string	m_longname

int	m_maxArgs

int	m_minArgs

std::string	m_shortname

Detailed Description

Command-line option with a single letter, full name and description plus an associated Geant4 command (which is optional).

Author: Jeremy McCormick jerem.nosp@m.ym@s.nosp@m.lac.s.nosp@m.tanf.nosp@m.ord.e.nosp@m.du

Definition at line 17 of file CommandLineOption.hh.

Constructor & Destructor Documentation

◆ CommandLineOption()

CommandLineOption	(	const std::string &	shortname,
		const std::string &	longname,
		const std::string &	description,
		unsigned int	minArgs = `0`,
		unsigned int	maxArgs = `0`,
		const std::string &	macroCommand = `""`
	)

inline

The fully qualified constructor for CommandLineOption.

Parameters

[in]	shortname	The single letter command switch.
[in]	longname	The longer name of the command.
[in]	minArgs	The minimum number of arguments.
[in]	maxArgs	The maximum number of arguments.
[in]	macroCommand	The corresponding Geant4 macro string.

Definition at line 29 of file CommandLineOption.hh.

◆ ~CommandLineOption()

virtual ~CommandLineOption ( )

inlinevirtual

Class destructor.

Definition at line 46 of file CommandLineOption.hh.

Member Function Documentation

◆ getDescription()

const std::string& getDescription ( ) const

inline

Get a brief description of this option.

Returns: A description of the option.

Definition at line 74 of file CommandLineOption.hh.

References CommandLineOption::m_description.

Referenced by CommandLineProcessor::printOptions().

◆ getG4CommandString()

const std::string& getG4CommandString ( ) const

inline

Get the Geant4 command associated with this option. This may be a null string if there is no associated Geant4 command, though currently all of SLIC's options have a corresponding macro.