BLCMDparam Class Reference

Inheritance diagram for BLCMDparam:

List of all members.

---

Detailed Description

class BLCMDparam implements the param command.

Public Member Functions
	BLCMDparam ()
	Constructor. registers the command and provides help text.
virtual G4String	commandName ()
	commandName() returns "param";
int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)
	command() implements the param command. It does not use the standard handleNamedArgs(), but accepts any named argument and defines a parameter of that name. Unnamed args are ignored with a warning. If no args are present, calls printParam().
void	printParam ()
	printParam() will display all parameters on stdout.
virtual void	help (bool detailed)
Private Member Functions
void	init ()
Static Private Attributes
static std::map< G4String, G4String > *	paramMap

---

Constructor & Destructor Documentation

BLCMDparam::BLCMDparam

(

)

Constructor. registers the command and provides help text.

References BLCMDTYPE_CONTROL, BLCommand::registerCommand(), BLCommand::setDescription(), and BLCommand::setSynopsis().

{
        registerCommand(BLCMDTYPE_CONTROL);
        setSynopsis("Defines parameter values.");
        setDescription("Parameters are named strings used to parameterize "
            "the input file; a few are used for program control.\n"
            "Parameters are set by the param commend, and on the command "
            "line (all program arguments after the first are interpreted "
            "as name=value).\n\n"
            "'param name=value ...' defines parameters.\n"
            "If no arguments are present, all parameters are displayed. "
            "If the first argument is '-unset', this command will not\n"
            "overwrite parameters that are already set (e.g. from the\n"
            "command line - this permits the input.file to set defaults "
            "that can be overridden on the command line).\n\n"
            "Parameters are expanded only in the arguments of commands:\n"
            "'cmd argname=$paramname [...]'; real-valued expressions for "
            "arguments can use $paramname as a value, as long as paramname "
            "contains a valid real expression.\n\n"
            "Parameters are most useful for setting global things like viewer\n"
            "and histoFile, or as parameters used in the input.file.\n\n"
            "When a parameter is used, if it has not been defined, it will "
            "be defined from the environment if possible; if it is not defined "
            "in the environment then this generates an error message.\n\n"
            "The values of parameters are strings, but if the value of a "
            "parameter is set to a valid real expression including at least "
            "one operator {+-*/^<>=()!~&%|?}, the parameter value will "
            "be set to the numerical value of the expression to 8 significant "
            "digits.\n\n"
            "NOTE: pre-defined Program control parameters (listed below) are "
            "defined before the command-line and are not affected by -unset.");
}

---

Member Function Documentation

void BLCMDparam::init

(

)

[inline, private]

References paramMap.

{if (!paramMap) paramMap = new std::map<G4String,G4String>;}

virtual G4String BLCMDparam::commandName

(

)

[inline, virtual]

commandName() returns "param";

Implements BLCommand.

Referenced by command().

{ return "param"; }

int BLCMDparam::command	(	BLArgumentVector &	argv,
		BLArgumentMap &	namedArgs
	)			[virtual]

command() implements the param command. It does not use the standard handleNamedArgs(), but accepts any named argument and defines a parameter of that name. Unnamed args are ignored with a warning. If no args are present, calls printParam().

Implements BLCommand.

References commandName(), BLEvaluator::evaluate(), BLParam::getString(), IndentArg(), IndentDesc(), BLParam::isDefined(), Param, printParam(), BLParam::setParam(), and snprintf.

{
        bool unset = false;

        if(argv.size() > 0 && argv[0] == "-unset") {
                unset = true;
        }
        if(argv.size() > (unset ? 1 : 0)) {
                G4Exception("param command","un-named arguments ignored",
                                        JustWarning, "");
        }

        if(namedArgs.size() > 0) {
                BLArgumentMap::iterator i;
                for(i=namedArgs.begin(); i!=namedArgs.end(); ++i) {
                        bool defined = Param.isDefined(i->first);
                        if(!unset || !defined) {
                                // check if value is a valid expression
                                { BLEvaluator e;
                                  G4double v = e.evaluate(i->second);
                                  // e has many symbols that conflict with
                                  // simple symbols (e.g. "C" for Coulomb), so
                                  // require an operator before evaluating as
                                  // an expression
                                  if(e.status() == HepTool::Evaluator::OK &&
                                     i->second.find_first_of("+-*/^<>=()!~&%|?")
                                                        != i->second.npos) {
                                        char tmp[64];
                                        snprintf(tmp,sizeof(tmp),"%.8g",v);
                                        Param.setParam(i->first,tmp);
                                  } else {
                                        Param.setParam(i->first,i->second);
                                  }
                                }
                        }
                        // print param definition
                        G4String indent1(commandName());
                        do { indent1 += " "; }
                                while(indent1.size() < IndentDesc.size());
                        indent1 += i->first;
                        do { indent1 += " "; }
                                while(indent1.size() < IndentArg.size());
                        printf("%s%s%s\n",indent1.c_str(),
                                Param.getString(i->first).c_str(),
                                (unset&&defined ? "  (already defined)" : ""));
                }
        } else {
                printParam();
        }

        return 0;
}

void BLCMDparam::printParam

(

)

printParam() will display all parameters on stdout.

References Param, and BLParam::printParam().

Referenced by command().

{
        Param.printParam();
}

virtual void BLCMDparam::help

(

bool

detailed

)

[inline, virtual]

Reimplemented from BLCommand.

References BLParam::getHelpText(), BLManager::getObject(), BLCommand::help(), and Param.

                                         {
                BLCommand::help(detailed);
                if(detailed) {
                    printf("\nProgram control Parameters:\n%s",
                                                Param.getHelpText().c_str());
                    printf("steppingFormat is a space- or comma-separated list of items:\n%s\n\n",
                        BLManager::getObject()->getFormatHelp().c_str());
                }
        }

---

Member Data Documentation

std::map<G4String,G4String>* BLCMDparam::paramMap [static, private]

Referenced by init().

---

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

• BLCMDparam.cc