BLCommand Class Reference

#include <BLCommand.hh>

Inheritance diagram for BLCommand:

List of all members.

---

Detailed Description

class BLCommand - interface to define a command.

The standard usage for a command without a BLElement is to derive from this class and define a static instance using the default constructor. In the derived-class default constructor the command is registered, calls to setSynopsis() and setDescription() provide help text, and initial values are given to all class variables. This instance is used to execute the command, and normally no other instances are needed.

The static instance is used to keep the default arguments for the element.

Standard usage for a command for a BLElement is to derive a class from BLElement (which is derived from BLCommand), and do the above in its default constructor. The derived command() function then creates an instance of the class. Only the static instance is used to execute the command, but other instances implement the various elements (to be placed later in the input file).

See BLCMDdemo.cc and BLCMDtubs.cc for examples (.hh files are not needed for most commands, as their classes are not needed anywhere but in their implementation file).

NOTE: ONLY the default object should use the default constructor!

Public Member Functions
virtual G4String	commandName ()=0
	commandName() returns the name of the command.
virtual int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)=0
	command() executes the command associated with this element. argv and namedArgs come from parsing the command-line: argv has a vector of any positional arguments (without "="); namedArgs has a map of any named arguments of the form name=value. Returns 0 if OK, -1 on error. NOTE: for classes derived via BLElement.hh, arguments can be given when an object is defined and when it is placed. For that to work, argument values must not be used in the command() function unless they are defined with permitChange=false (in the above argString... functions). Also the correct units must be given to argDouble().
virtual void	defineNamedArgs ()
	defineNamedArgs() defines the named arguments for the command. This function should consist ONLY of a series of calls to argString(), argDouble(), and argInt(). Used by handleNamedArgs(), help(), and print() (they manipulate the behavior of the argXXX() functions via argMode).
virtual void	argChanged ()
	argChanged() will be called whenever some argument value has changed. Derived classes should define it and perform any internal computations that depend on argument values. Many/most derived classes won't need to use it. In particular, after argChanged() returns the functions getHeight(), getWidth() and getLength() must return the correct values for the current arguments. BEWARE: a single argument change may call this multiple times. Applies only to named arguments, not positional ones.
virtual void	print (G4String name)
	print() will print to stdout the command. The default versions will do for most commands and elements. name can be "". prints commandname() and name in the space of IndentArg, followed by the values of all named arguments, in the order they appear in defineNamedArgs().
void	print (G4String name, BLArgumentMap &namedArgs)
	Print() -- alternate version for commands with special arguments. does not use defineNamedArgs() to print arguments, but rather prints namedArgs.
virtual G4String	getName () const
	getName() returns the element's name; do not confuse this with commandName(). Re-defined by BLElement.
BLCmdType	getCmdType ()
	getCmdType() returns the type of this command
void	setPos (BLCommandPos &pos)
	setPos() will set the Command input stream to a specified position
Static Public Member Functions
static double	undefined ()
	undefined() returns a quiet Not-A-Number, for initializing arguments to determine if the user set them or not.
static bool	isUndefined (double v)
	isUndefined() determines wheter an argument has been set.
static bool	isValidCommand (G4String &cmd)
	isValidCommand() returns true if cmd is a valid command.
static int	doCommand (G4String &line)
	doCommand() will parse line and perform a single command. Returns 0 if OK, -1 if error.
static int	parseArgs (const G4String &line, BLArgumentVector &argv, BLArgumentMap &namedArgs)
	parseArgs() will parse the arguments of a command line. Arguments are appended to argv[] and added to namedArgs. Returns 0 if OK, -1 if syntax error.
static int	readFile (G4String filename)
	readFile() reads a file of commands and executes them. "-" is stdin. Returns the number of errors encountered, or -1 if filename cannot be read.
static void	printError (const char *fmt,...)
	printError() prints an error message, using sprintf-style args. It also increments the errorCount.
static int	getErrorCount ()
	getErrorCount() will return the number of errors so far.
static G4String *	getNextCommand ()
	getNextCommand() returns the next command. backslash-newline has been handled, and the line is stripped of whitespace at both ends. returns 0 if error or EOF. The pointer should NOT be deleted.
static BLCommandPos	getPos ()
	getPos() returns the current position of the Command input stream
static G4Material *	getMaterial (G4String materialName, bool error=true)
	getMaterial() searches the G4Material list and returns the entry corresponding to name. Searches the NIST database if the material is not already defined. Prepends "G4_" if necessary. prints an error and exits if the material is not found, so all materials MUST be defined before they are used, unless they can be found in the geant4 NIST database.
static G4VisAttributes *	getVisAttrib (G4String color)
	getVisAttrib() returns the appropriate G4VisAttributes.
static G4RotationMatrix *	stringToRotationMatrix (G4String rotation)
	stringToRotationMatrix() converts a string "X90,Y45" into a G4RotationMatrix. This is an active rotation, in that the object is first rotated around the parent's X axis by 90 degrees, then the object is further rotated around the parent's Y axis by 45 degrees. The return value points to a G4RotationMatrix on the heap, so it is persistent. Angles are in degrees, can have decimals, and can be negative. Axes are X, Y, Z. NOTE: This is expensive and should not be used during tracking.
static void	dumpRotation (const G4RotationMatrix *rot, const char *str)
	dumpRotation() dumps info about a rotation matrix to stdout. NOTE: This is expensive and should not be used during tracking.
static std::vector< G4String >	splitString (const G4String &s, const G4String &delim, bool trim=false)
	splitString() splits a string at each instance of any character in delim, returning a vector<G4String>. If trim is true, each returned string has whitespace removed from its front and rear. Successive delimiters, or delimiters at the beginning or end, generate an empty string. NOTE: This is expensive and should not be used during tracking.
static double	getDouble (const G4String &s)
	getDouble() converts a string expression to a double, returning nan if the string is not a valid expression using double constants and standard C operators and functions; whitespace is permitted as in C but an empty or all-whitespace string is invalid. Callers can use std::isnan(double) or gsl_isnan(double) to test for validity. NOTE: This is expensive and should not be used during tracking.
static std::vector< G4double >	getList (const G4String &s, const G4String &delim)
	getList() converts a string containing a delimited list of double expressions to a vector<G4double>. Any character in delim separates entries. Functions and operators known to BLEvaluator can be used in each entry of the list. Empty entries (null or consisting only of whitespace) are invalid. Returns an empty list if any entry is an invalid expression. NOTE: This is expensive and should not be used during tracking.
static bool	matchList (const G4String s, const G4String patternList)
	matchList() returns true if s matches any pattern in patternList, whch is a comma-separated list of file-glob patterns. NOTE: This is expensive and should not be used during tracking.
Protected Types
enum	ArgumentMode {   PROCESS, COUNT, HELP, PRINT,   CHANGE }
Protected Member Functions
	BLCommand ()
	Default Constructor.
virtual	~BLCommand ()
	Destructor.
	BLCommand (const BLCommand &r)
	Copy Constructor.
void	registerCommand (BLCmdType _type)
	registerCommand() registers the command. Used only in the default constructor -- ensures mapCommand is properly initialized regardless of order.
void	deleteCommand (G4String &name)
	deleteCommand() will delete a command by name
void	setSynopsis (const char *_synopsis)
	setSynopsis() gives a 1-line (64 char) description of what the command does. Used by the help command with no arguments. The string should be 64 characters or less, and should not contain any newline; no word wrapping. Used only in the default constructor.
void	setDescription (const char *_description)
	setDescription() gives a more complete description of the command, when help for this specific command is requested. When printed by the help() function, word wrapping is performed, but lines beginning with whitespace are kept intact. Named arguments are automatically described by the help() function, but positional arguments should be described here. Words are wrapped using wrapWords(). Used only in the default constructor.
void	argString (G4String &var, G4String name, G4String description, bool permitChange=true)
	argString() declares a string-valued argument. name should be a valid C identifier 15 chars or less, and description should be a short description (wrapWords() is used). Used only in the defineNamedArgs() function. permitChange affects whether this argument can be set when an element is placed.
void	argDouble (G4double &var, G4String name, G4String description, G4double units=1.0, G4String fmt=DefaultDoubleFmt, bool permitChange=true)
	argDouble() declares a G4double-valued argument. name should be a valid C identifier 15 chars or less, and description should be a short description (wrapWords() is used). Used only in the defineNamedArgs() function. units should be the human units for the argument, because the value of var is always in internal units. fmt and units are used when argMode=PRINT. permitChange affects whether this argument can be set when an element is placed.
void	argTunable (G4double &var, G4String name, G4String description, G4double units=1.0, G4String fmt=DefaultDoubleFmt)
	argTunable() declares a G4double-valued argument that is tunable (see the tune command in BLCMDtune.cc). name should be a valid C identifier 15 chars or less, and description should be a short description (wrapWords() is used). Used only in the defineNamedArgs() function. units should be the human units for the argument, because the value of var is always in internal units. fmt and units are used when argMode=PRINT. Tunable arguments can always be set when an element is placed, and will be changed during the tracking of the Tune Particle if their value includes a tune variable. See BLTune.hh for a description of how tunable arguments are handled.
void	argInt (G4int &var, G4String name, G4String description, bool permitChange=true)
	argInt() declares a integer-valued argument. name should be a valid C identifier 15 chars or less, and description should be a short description (wrapWords() is used). Used only in the defineNamedArgs() function. permitChange affects whether this argument can be set when an element is placed.
int	handleNamedArgs (BLArgumentMap &namedArgs)
	handleNamedArgs() handles all named arguments to the command (i.e. those defined in defineNamedArgs()). For use in the command() function. returns 0 if OK, -1 on error.
virtual void	help (bool detailed)
	help() prints the help information for this command. detailed=false prints only the name and synopsis; true prints the description and arguments also.
G4String	wrapWords (G4String text, G4String indent1, G4String indent, G4String::size_type width=79)
	wrapWords() will wrap words for descriptions in help(). In text, lines beginning with whitespace are preserved as is, including blank lines. Otherwise, newlines aren't needed in text. indent1 is the start of the first line, and indent is used at the start of succeeding lines ("" is OK); indents are counted in the line width. The returned string always ends with "\n".
void	printArgs (G4String indent1)
	printArgs() will print (to stdout) the named arguments of the command entered, for log purposes. Calls defineNamedArgs() with argMode=PRINT to print the args. indent1 is the indent for the first line.
Protected Attributes
ArgumentMode	argMode
bool	argFound
G4String	argName
G4String	argValue
G4String	synopsis
G4String	description
G4String	printArgString
int	nArgs
int	nFixed
int	nTunable
BLCmdType	type
Private Types
enum	TokenType { NONE, ARGNAME, ARGVALUE }
Private Member Functions
void	printArgDesc (G4String name, G4String _description)
	printArgDesc will print the description of an argument, using wrapWords().
Static Private Member Functions
static G4String	nextToken (const G4String &line, G4String::size_type &place, TokenType &type)
	nextToken() will return the next token in line; called only by doCommand(). Side-effect: updates place and sets type.
Static Private Attributes
static std::map< G4String, BLCommand * > *	mapCommand
static int	errors = 0
static std::istream *	in = 0
Friends
class	BLCMDplace
class	BLCMDhelp

---

Member Enumeration Documentation

enum BLCommand::TokenType [private]

Enumerator:

NONE
ARGNAME
ARGVALUE

{ NONE, ARGNAME, ARGVALUE };

enum BLCommand::ArgumentMode [protected]

Enumerator:

PROCESS
COUNT
HELP
PRINT
CHANGE

{ PROCESS, COUNT, HELP, PRINT, CHANGE };

---

Constructor & Destructor Documentation

BLCommand::BLCommand

(

)

[inline, protected]

Default Constructor.

                    : synopsis(), description()
                { }

BLCommand::~BLCommand

(

)

[protected, virtual]

Destructor.

{
}

BLCommand::BLCommand

(

const BLCommand &

r

)

[inline, protected]

Copy Constructor.

                                      : synopsis(), description()
                { }

---

Member Function Documentation

G4String BLCommand::nextToken	(	const G4String &	line,
		G4String::size_type &	place,
		TokenType &	type
	)			[static, private]

nextToken() will return the next token in line; called only by doCommand(). Side-effect: updates place and sets type.

References ARGNAME, ARGVALUE, and NONE.

Referenced by doCommand(), and parseArgs().

{
        // (add +- for particlecolor pi+=1,1,1)
        static const char namechars[] = ",+-ABCDEFGHIJKLMNOPQRSTUVWXYZ_"
                                       "abcdefghijklmnopqrstuvwxyz0123456789";
        G4String::size_type i;

        // check if previous token was ARGNAME
        if(line[place] == '=') {
                ++place;
                goto value;
        }

        // skip initial whitespace
        while(place < line.size() && isspace(line[place])) ++place;

        // check for ARGNAME
        if(isalnum(line[place]) || line[place] == '_') {
                i = line.find_first_not_of(namechars,place);
                if(i > place && i < line.size() && line[i] == '=' &&
                                                        line[i+1] != '=') {
                        G4String retval = line.substr(place,i-place);
                        place = i;
                        type = ARGNAME;
                        return retval;
                }
        }
value:
        if(line[place] == '"') {
                ++place;
                i = line.find('"',place);
                if(i <line.size()) {
                        G4String retval = line.substr(place,i-place);
                        place = i + 1;
                        type = ARGVALUE;
                        return retval;
                }
        } else if(line[place] == '\'') {
                ++place;
                i = line.find('\'',place);
                if(i <line.size()) {
                        G4String retval = line.substr(place,i-place);
                        place = i + 1;
                        type = ARGVALUE;
                        return retval;
                }
        }

        if(place >= line.size()) {
                type = NONE;
                return "";
        }

        // find next whitespace
        G4String::size_type start = place;
        while(place < line.size() && !isspace(line[place])) ++place;

        type = ARGVALUE;

        return line.substr(start,place-start);
}

void BLCommand::printArgDesc	(	G4String	name,
		G4String	_description
	)			[private]

printArgDesc will print the description of an argument, using wrapWords().

References IndentArg(), IndentDesc(), and wrapWords().

Referenced by argDouble(), argInt(), argString(), and argTunable().

{
        G4String indent1(IndentDesc);
        indent1 += name;
        do { indent1 += " "; } while(indent1.size() < IndentArg.size());
        printf("%s",wrapWords(_description,indent1,IndentArg).c_str());
}

void BLCommand::registerCommand

(

BLCmdType

_type

)

[protected]

registerCommand() registers the command. Used only in the default constructor -- ensures mapCommand is properly initialized regardless of order.

References commandName(), mapCommand, printError(), and type.

Referenced by BLCMDabsorber::BLCMDabsorber(), BLCMDbeam::BLCMDbeam(), BLCMDbeamlossntuple::BLCMDbeamlossntuple(), BLCMDbox::BLCMDbox(), BLCMDbug1021::BLCMDbug1021(), BLCMDcoil::BLCMDcoil(), BLCMDcollective::BLCMDcollective(), BLCMDcorner::BLCMDcorner(), BLCMDcornerarc::BLCMDcornerarc(), BLCMDcosmicraybeam::BLCMDcosmicraybeam(), BLCMDdefine::BLCMDdefine(), BLCMDdemo::BLCMDdemo(), BLCMDdo::BLCMDdo(), BLCMDendgroup::BLCMDendgroup(), BLCMDeventcuts::BLCMDeventcuts(), BLCMDexit::BLCMDexit(), BLCMDextrusion::BLCMDextrusion(), BLCMDfieldexpr::BLCMDfieldexpr(), BLCMDfieldlines::BLCMDfieldlines(), BLCMDfieldmap::BLCMDfieldmap(), BLCMDfieldntuple::BLCMDfieldntuple(), BLCMDg4ui::BLCMDg4ui(), BLCMDgenericbend::BLCMDgenericbend(), BLCMDgenericquad::BLCMDgenericquad(), BLCMDgeometry::BLCMDgeometry(), BLCMDhelicaldipole::BLCMDhelicaldipole(), BLCMDhelicalharmonic::BLCMDhelicalharmonic(), BLCMDhelp::BLCMDhelp(), BLCMDidealsectorbend::BLCMDidealsectorbend(), BLCMDif::BLCMDif(), BLCMDinclude::BLCMDinclude(), BLCMDlilens::BLCMDlilens(), BLCMDlist::BLCMDlist(), BLCMDmaterial::BLCMDmaterial(), BLCMDmovie::BLCMDmovie(), BLCMDmultipole::BLCMDmultipole(), BLCMDmuminuscapturefix::BLCMDmuminuscapturefix(), BLCMDnewparticlentuple::BLCMDnewparticlentuple(), BLCMDntuple::BLCMDntuple(), BLCMDoutput::BLCMDoutput(), BLCMDparam::BLCMDparam(), BLCMDparticlecolor::BLCMDparticlecolor(), BLCMDparticlefilter::BLCMDparticlefilter(), BLCMDparticlesource::BLCMDparticlesource(), BLCMDphysics::BLCMDphysics(), BLCMDpillbox::BLCMDpillbox(), BLCMDplace::BLCMDplace(), BLCMDpolycone::BLCMDpolycone(), BLCMDprintf::BLCMDprintf(), BLCMDprintfield::BLCMDprintfield(), BLCMDprobefield::BLCMDprobefield(), BLCMDprofile::BLCMDprofile(), BLCMDrandomseed::BLCMDrandomseed(), BLCMDreference::BLCMDreference(), BLCMDreweightprocess::BLCMDreweightprocess(), BLCMDrfdevice::BLCMDrfdevice(), BLCMDsetdecay::BLCMDsetdecay(), BLCMDshowmaterial::BLCMDshowmaterial(), BLCMDsolenoid::BLCMDsolenoid(), BLCMDspacecharge::BLCMDspacecharge(), BLCMDspacechargelw::BLCMDspacechargelw(), BLCMDsphere::BLCMDsphere(), BLCMDstart::BLCMDstart(), BLCMDtest::BLCMDtest(), BLCMDtimentuple::BLCMDtimentuple(), BLCMDtorus::BLCMDtorus(), BLCMDtotalenergy::BLCMDtotalenergy(), BLCMDtrace::BLCMDtrace(), BLCMDtrackcuts::BLCMDtrackcuts(), BLCMDtracker::BLCMDtracker(), BLCMDtrackermode::BLCMDtrackermode(), BLCMDtrackerplane::BLCMDtrackerplane(), BLCMDtrap::BLCMDtrap(), BLCMDtubs::BLCMDtubs(), BLCMDtune::BLCMDtune(), BLCMDusertrackfilter::BLCMDusertrackfilter(), BLCMDvirtualdetector::BLCMDvirtualdetector(), BLCMDzntuple::BLCMDzntuple(), BLCommandAlias::BLCommandAlias(), BLGroup::BLGroup(), and Macro::Macro().

{
        type = _type;

        if(!mapCommand)
                mapCommand = new std::map<G4String,BLCommand*>;
        if((*mapCommand).count(commandName()) > 0 &&
           (*mapCommand)[commandName()] != this)
                printError("Attempt to re-define the command '%s'",
                                commandName().c_str());
        else
                (*mapCommand)[commandName()] = this;
}

void BLCommand::deleteCommand

(

G4String &

name

)

[inline, protected]

deleteCommand() will delete a command by name

References mapCommand.

Referenced by Macro::Macro().

                { if(mapCommand) mapCommand->erase(name); }

void BLCommand::setSynopsis

(

const char *

_synopsis

)

[inline, protected]

setSynopsis() gives a 1-line (64 char) description of what the command does. Used by the help command with no arguments. The string should be 64 characters or less, and should not contain any newline; no word wrapping. Used only in the default constructor.

References synopsis.

Referenced by BLCMDabsorber::BLCMDabsorber(), BLCMDbeam::BLCMDbeam(), BLCMDbeamlossntuple::BLCMDbeamlossntuple(), BLCMDbox::BLCMDbox(), BLCMDbug1021::BLCMDbug1021(), BLCMDcoil::BLCMDcoil(), BLCMDcollective::BLCMDcollective(), BLCMDcorner::BLCMDcorner(), BLCMDcornerarc::BLCMDcornerarc(), BLCMDcosmicraybeam::BLCMDcosmicraybeam(), BLCMDdefine::BLCMDdefine(), BLCMDdemo::BLCMDdemo(), BLCMDdo::BLCMDdo(), BLCMDendgroup::BLCMDendgroup(), BLCMDeventcuts::BLCMDeventcuts(), BLCMDexit::BLCMDexit(), BLCMDextrusion::BLCMDextrusion(), BLCMDfieldexpr::BLCMDfieldexpr(), BLCMDfieldlines::BLCMDfieldlines(), BLCMDfieldmap::BLCMDfieldmap(), BLCMDfieldntuple::BLCMDfieldntuple(), BLCMDg4ui::BLCMDg4ui(), BLCMDgenericbend::BLCMDgenericbend(), BLCMDgenericquad::BLCMDgenericquad(), BLCMDgeometry::BLCMDgeometry(), BLCMDhelicaldipole::BLCMDhelicaldipole(), BLCMDhelicalharmonic::BLCMDhelicalharmonic(), BLCMDhelp::BLCMDhelp(), BLCMDidealsectorbend::BLCMDidealsectorbend(), BLCMDif::BLCMDif(), BLCMDinclude::BLCMDinclude(), BLCMDlilens::BLCMDlilens(), BLCMDlist::BLCMDlist(), BLCMDmaterial::BLCMDmaterial(), BLCMDmovie::BLCMDmovie(), BLCMDmultipole::BLCMDmultipole(), BLCMDmuminuscapturefix::BLCMDmuminuscapturefix(), BLCMDnewparticlentuple::BLCMDnewparticlentuple(), BLCMDntuple::BLCMDntuple(), BLCMDoutput::BLCMDoutput(), BLCMDparam::BLCMDparam(), BLCMDparticlecolor::BLCMDparticlecolor(), BLCMDparticlefilter::BLCMDparticlefilter(), BLCMDparticlesource::BLCMDparticlesource(), BLCMDphysics::BLCMDphysics(), BLCMDpillbox::BLCMDpillbox(), BLCMDplace::BLCMDplace(), BLCMDpolycone::BLCMDpolycone(), BLCMDprintf::BLCMDprintf(), BLCMDprintfield::BLCMDprintfield(), BLCMDprobefield::BLCMDprobefield(), BLCMDprofile::BLCMDprofile(), BLCMDrandomseed::BLCMDrandomseed(), BLCMDreference::BLCMDreference(), BLCMDreweightprocess::BLCMDreweightprocess(), BLCMDrfdevice::BLCMDrfdevice(), BLCMDsetdecay::BLCMDsetdecay(), BLCMDshowmaterial::BLCMDshowmaterial(), BLCMDsolenoid::BLCMDsolenoid(), BLCMDspacecharge::BLCMDspacecharge(), BLCMDspacechargelw::BLCMDspacechargelw(), BLCMDsphere::BLCMDsphere(), BLCMDstart::BLCMDstart(), BLCMDtest::BLCMDtest(), BLCMDtimentuple::BLCMDtimentuple(), BLCMDtorus::BLCMDtorus(), BLCMDtotalenergy::BLCMDtotalenergy(), BLCMDtrace::BLCMDtrace(), BLCMDtrackcuts::BLCMDtrackcuts(), BLCMDtracker::BLCMDtracker(), BLCMDtrackermode::BLCMDtrackermode(), BLCMDtrackerplane::BLCMDtrackerplane(), BLCMDtrap::BLCMDtrap(), BLCMDtubs::BLCMDtubs(), BLCMDtune::BLCMDtune(), BLCMDusertrackfilter::BLCMDusertrackfilter(), BLCMDvirtualdetector::BLCMDvirtualdetector(), BLCMDzntuple::BLCMDzntuple(), BLCommandAlias::BLCommandAlias(), BLGroup::BLGroup(), and Macro::Macro().

                { synopsis = _synopsis; }

void BLCommand::setDescription

(

const char *

_description

)

[inline, protected]

setDescription() gives a more complete description of the command, when help for this specific command is requested. When printed by the help() function, word wrapping is performed, but lines beginning with whitespace are kept intact. Named arguments are automatically described by the help() function, but positional arguments should be described here. Words are wrapped using wrapWords(). Used only in the default constructor.

References description.

Referenced by BLCMDabsorber::BLCMDabsorber(), BLCMDbeam::BLCMDbeam(), BLCMDbeamlossntuple::BLCMDbeamlossntuple(), BLCMDbox::BLCMDbox(), BLCMDbug1021::BLCMDbug1021(), BLCMDcoil::BLCMDcoil(), BLCMDcollective::BLCMDcollective(), BLCMDcorner::BLCMDcorner(), BLCMDcornerarc::BLCMDcornerarc(), BLCMDcosmicraybeam::BLCMDcosmicraybeam(), BLCMDdefine::BLCMDdefine(), BLCMDdemo::BLCMDdemo(), BLCMDdo::BLCMDdo(), BLCMDendgroup::BLCMDendgroup(), BLCMDeventcuts::BLCMDeventcuts(), BLCMDexit::BLCMDexit(), BLCMDextrusion::BLCMDextrusion(), BLCMDfieldexpr::BLCMDfieldexpr(), BLCMDfieldlines::BLCMDfieldlines(), BLCMDfieldmap::BLCMDfieldmap(), BLCMDfieldntuple::BLCMDfieldntuple(), BLCMDg4ui::BLCMDg4ui(), BLCMDgenericbend::BLCMDgenericbend(), BLCMDgenericquad::BLCMDgenericquad(), BLCMDgeometry::BLCMDgeometry(), BLCMDhelicaldipole::BLCMDhelicaldipole(), BLCMDhelicalharmonic::BLCMDhelicalharmonic(), BLCMDhelp::BLCMDhelp(), BLCMDidealsectorbend::BLCMDidealsectorbend(), BLCMDif::BLCMDif(), BLCMDinclude::BLCMDinclude(), BLCMDlilens::BLCMDlilens(), BLCMDlist::BLCMDlist(), BLCMDmaterial::BLCMDmaterial(), BLCMDmovie::BLCMDmovie(), BLCMDmultipole::BLCMDmultipole(), BLCMDmuminuscapturefix::BLCMDmuminuscapturefix(), BLCMDnewparticlentuple::BLCMDnewparticlentuple(), BLCMDntuple::BLCMDntuple(), BLCMDoutput::BLCMDoutput(), BLCMDparam::BLCMDparam(), BLCMDparticlecolor::BLCMDparticlecolor(), BLCMDparticlefilter::BLCMDparticlefilter(), BLCMDparticlesource::BLCMDparticlesource(), BLCMDphysics::BLCMDphysics(), BLCMDpillbox::BLCMDpillbox(), BLCMDplace::BLCMDplace(), BLCMDpolycone::BLCMDpolycone(), BLCMDprintf::BLCMDprintf(), BLCMDprintfield::BLCMDprintfield(), BLCMDprobefield::BLCMDprobefield(), BLCMDprofile::BLCMDprofile(), BLCMDrandomseed::BLCMDrandomseed(), BLCMDreference::BLCMDreference(), BLCMDreweightprocess::BLCMDreweightprocess(), BLCMDrfdevice::BLCMDrfdevice(), BLCMDsetdecay::BLCMDsetdecay(), BLCMDshowmaterial::BLCMDshowmaterial(), BLCMDsolenoid::BLCMDsolenoid(), BLCMDspacecharge::BLCMDspacecharge(), BLCMDspacechargelw::BLCMDspacechargelw(), BLCMDsphere::BLCMDsphere(), BLCMDstart::BLCMDstart(), BLCMDtest::BLCMDtest(), BLCMDtimentuple::BLCMDtimentuple(), BLCMDtorus::BLCMDtorus(), BLCMDtotalenergy::BLCMDtotalenergy(), BLCMDtrace::BLCMDtrace(), BLCMDtrackcuts::BLCMDtrackcuts(), BLCMDtracker::BLCMDtracker(), BLCMDtrackermode::BLCMDtrackermode(), BLCMDtrackerplane::BLCMDtrackerplane(), BLCMDtrap::BLCMDtrap(), BLCMDtubs::BLCMDtubs(), BLCMDtune::BLCMDtune(), BLCMDusertrackfilter::BLCMDusertrackfilter(), BLCMDvirtualdetector::BLCMDvirtualdetector(), BLCMDzntuple::BLCMDzntuple(), BLCommandAlias::BLCommandAlias(), and BLGroup::BLGroup().

                { description = _description; }

void BLCommand::argString	(	G4String &	var,
		G4String	name,
		G4String	description,
		bool	permitChange = true
	)			[protected]

argString() declares a string-valued argument. name should be a valid C identifier 15 chars or less, and description should be a short description (wrapWords() is used). Used only in the defineNamedArgs() function. permitChange affects whether this argument can be set when an element is placed.

References argFound, argMode, argName, argValue, CHANGE, commandName(), COUNT, HELP, nArgs, nFixed, PRINT, printArgDesc(), printArgString, printError(), and PROCESS.

Referenced by BLCMDzntuple::defineNamedArgs(), BLCMDvirtualdetector::defineNamedArgs(), BLCMDusertrackfilter::defineNamedArgs(), BLCMDtune::defineNamedArgs(), BLCMDtubs::defineNamedArgs(), BLCMDtrap::defineNamedArgs(), BLCMDtrackermode::defineNamedArgs(), BLCMDtrackerplane::defineNamedArgs(), BLCMDtracker::defineNamedArgs(), BLCMDtrackcuts::defineNamedArgs(), BLCMDtrace::defineNamedArgs(), BLCMDtotalenergy::defineNamedArgs(), BLCMDtorus::defineNamedArgs(), BLCMDtimentuple::defineNamedArgs(), BLCMDstart::defineNamedArgs(), BLCMDsphere::defineNamedArgs(), BLCMDsolenoid::defineNamedArgs(), BLCMDrfdevice::defineNamedArgs(), BLCMDreweightprocess::defineNamedArgs(), BLCMDreference::defineNamedArgs(), BLCMDprofile::defineNamedArgs(), BLCMDprobefield::defineNamedArgs(), BLCMDprintfield::defineNamedArgs(), BLCMDprintf::defineNamedArgs(), BLCMDpolycone::defineNamedArgs(), BLCMDplace::defineNamedArgs(), BLCMDpillbox::defineNamedArgs(), BLCMDphysics::defineNamedArgs(), BLCMDparticlefilter::defineNamedArgs(), BLCMDntuple::defineNamedArgs(), BLCMDnewparticlentuple::defineNamedArgs(), BLCMDmultipole::defineNamedArgs(), BLCMDmovie::defineNamedArgs(), BLCMDmaterial::defineNamedArgs(), BLCMDlist::defineNamedArgs(), BLCMDlilens::defineNamedArgs(), BLCMDidealsectorbend::defineNamedArgs(), BLGroup::defineNamedArgs(), BLCMDgenericquad::defineNamedArgs(), BLCMDgenericbend::defineNamedArgs(), BLCMDfieldntuple::defineNamedArgs(), BLCMDfieldmap::defineNamedArgs(), BLCMDfieldlines::defineNamedArgs(), BLCMDfieldexpr::defineNamedArgs(), BLCMDextrusion::defineNamedArgs(), BLCMDeventcuts::defineNamedArgs(), BLCMDdemo::defineNamedArgs(), BLCMDcornerarc::defineNamedArgs(), BLCMDcorner::defineNamedArgs(), BLCMDcollective::defineNamedArgs(), BLCMDcoil::defineNamedArgs(), BLCMDbox::defineNamedArgs(), BLCMDbeamlossntuple::defineNamedArgs(), BLCMDbeam::defineNamedArgs(), and BLCMDabsorber::defineNamedArgs().

{
        switch(argMode) {
        case CHANGE:
                if(!permitChange) {
                        if(argName == name)
                                printError("%s: Argument '%s' is not permitted to change\n",
                                        commandName().c_str(),name.c_str());
                        break;
                }
                // flow into PROCESS
        case PROCESS:   
                if(argFound || argName != name) return;
                argFound = true;
                var = argValue;
                break;
        case COUNT:
                ++nArgs;
                if(!permitChange) ++nFixed;
                break;
        case HELP:      
                printArgDesc(name,_description+(permitChange?"":" #"));
                break;
        case PRINT:
                printArgString += name;
                printArgString += "=";
                printArgString += var;
                printArgString += "\n";
                break;
        }
}

void BLCommand::argDouble	(	G4double &	var,
		G4String	name,
		G4String	description,
		G4double	units = 1.0,
		G4String	fmt = DefaultDoubleFmt,
		bool	permitChange = true
	)			[protected]

argDouble() declares a G4double-valued argument. name should be a valid C identifier 15 chars or less, and description should be a short description (wrapWords() is used). Used only in the defineNamedArgs() function. units should be the human units for the argument, because the value of var is always in internal units. fmt and units are used when argMode=PRINT. permitChange affects whether this argument can be set when an element is placed.

References argFound, argMode, argName, argValue, CHANGE, commandName(), COUNT, DefaultDoubleFmt, BLEvaluator::evaluate(), HELP, nArgs, nFixed, PRINT, printArgDesc(), printArgString, printError(), PROCESS, and snprintf.

Referenced by BLCMDvirtualdetector::defineNamedArgs(), BLCMDusertrackfilter::defineNamedArgs(), BLCMDtune::defineNamedArgs(), BLCMDtubs::defineNamedArgs(), BLCMDtrap::defineNamedArgs(), BLCMDtrackerplane::defineNamedArgs(), BLCMDtracker::defineNamedArgs(), BLCMDtrackcuts::defineNamedArgs(), BLCMDtorus::defineNamedArgs(), BLCMDtimentuple::defineNamedArgs(), BLCMDstart::defineNamedArgs(), BLCMDsphere::defineNamedArgs(), BLCMDspacechargelw::defineNamedArgs(), BLCMDspacecharge::defineNamedArgs(), BLCMDsolenoid::defineNamedArgs(), BLCMDrfdevice::defineNamedArgs(), BLCMDreweightprocess::defineNamedArgs(), BLCMDreference::defineNamedArgs(), BLCMDprintfield::defineNamedArgs(), BLCMDprintf::defineNamedArgs(), BLCMDpolycone::defineNamedArgs(), BLCMDplace::defineNamedArgs(), BLCMDpillbox::defineNamedArgs(), BLCMDphysics::defineNamedArgs(), BLCMDparticlefilter::defineNamedArgs(), BLCMDmuminuscapturefix::defineNamedArgs(), BLCMDmultipole::defineNamedArgs(), BLCMDmaterial::defineNamedArgs(), BLCMDlilens::defineNamedArgs(), BLCMDidealsectorbend::defineNamedArgs(), BLCMDhelicalharmonic::defineNamedArgs(), BLCMDhelicaldipole::defineNamedArgs(), BLGroup::defineNamedArgs(), BLCMDgeometry::defineNamedArgs(), BLCMDgenericquad::defineNamedArgs(), BLCMDgenericbend::defineNamedArgs(), BLCMDfieldmap::defineNamedArgs(), BLCMDfieldlines::defineNamedArgs(), BLCMDfieldexpr::defineNamedArgs(), BLCMDextrusion::defineNamedArgs(), BLCMDdemo::defineNamedArgs(), BLCMDcosmicraybeam::defineNamedArgs(), BLCMDcornerarc::defineNamedArgs(), BLCMDcorner::defineNamedArgs(), BLCMDcollective::defineNamedArgs(), BLCMDcoil::defineNamedArgs(), BLCMDbug1021::defineNamedArgs(), BLCMDbox::defineNamedArgs(), BLCMDbeam::defineNamedArgs(), and BLCMDabsorber::defineNamedArgs().

{
        if(fmt == "") fmt = DefaultDoubleFmt;

        switch(argMode) {
        case CHANGE:
                if(!permitChange) {
                        if(argName == name)
                                printError("%s: Argument '%s' is not permitted to change\n",
                                        commandName().c_str(),name.c_str());
                        break;
                }
                // flow into PROCESS
        case PROCESS:   
                if(argFound || argName != name) return;
                argFound = true;
                { BLEvaluator e;
                  G4double v = e.evaluate(argValue);
                  if(e.status() != HepTool::Evaluator::OK) {
                          printError("Invalid value for argument '%s'"
                                " to command '%s'", argName.c_str(),
                                commandName().c_str());
                          return;
                  }
                  var = v * units;
                }
/**** 
                { const char *p=argValue.c_str();
                  char *q;
                  G4double v = strtod(p,&q);
                  if(p == q || *q != '\0') {
                        printError("Invalid value for argument '%s'"
                                " to command '%s'", argName.c_str(),
                                commandName().c_str());
                        return;
                  }
                  var = v * units;
                }
****/
                break;
        case COUNT:
                ++nArgs;
                if(!permitChange) ++nFixed;
                break;
        case HELP:      
                printArgDesc(name,_description+(permitChange?"":" #"));
                break;
        case PRINT:
                { char tmp[65];
                  snprintf(tmp,sizeof(tmp),fmt.c_str(),var/units);
                  printArgString += name;
                  printArgString += "=";
                  printArgString += tmp;
                  printArgString += "\n";
                }
                break;
        }
}

void BLCommand::argTunable	(	G4double &	var,
		G4String	name,
		G4String	description,
		G4double	units = 1.0,
		G4String	fmt = DefaultDoubleFmt
	)			[protected]

argTunable() declares a G4double-valued argument that is tunable (see the tune command in BLCMDtune.cc). name should be a valid C identifier 15 chars or less, and description should be a short description (wrapWords() is used). Used only in the defineNamedArgs() function. units should be the human units for the argument, because the value of var is always in internal units. fmt and units are used when argMode=PRINT. Tunable arguments can always be set when an element is placed, and will be changed during the tracking of the Tune Particle if their value includes a tune variable. See BLTune.hh for a description of how tunable arguments are handled.

References argFound, argMode, argName, argValue, CHANGE, COUNT, DefaultDoubleFmt, BLTune::defineTunableArg(), HELP, nArgs, nTunable, PRINT, printArgDesc(), printArgString, PROCESS, and snprintf.

Referenced by BLCMDrfdevice::defineNamedArgs(), BLCMDpillbox::defineNamedArgs(), BLCMDidealsectorbend::defineNamedArgs(), BLCMDgenericbend::defineNamedArgs(), BLCMDfieldmap::defineNamedArgs(), and BLCMDfieldexpr::defineNamedArgs().

{
        if(fmt == "") fmt = DefaultDoubleFmt;

        switch(argMode) {
        case CHANGE:
        case PROCESS:   
                if(argFound || argName != name) return;
                argFound = true;
                BLTune::defineTunableArg(var,units,argValue);
                break;
        case HELP:      
                printArgDesc(name,_description+" @");
                break;
        case COUNT:
                ++nArgs;
                ++nTunable;
                break;
        case PRINT:
                { char tmp[65];
                  snprintf(tmp,sizeof(tmp),fmt.c_str(),var/units);
                  printArgString += name;
                  printArgString += "=";
                  printArgString += tmp;
                  printArgString += "\n";
                }
                break;
        }
}

void BLCommand::argInt	(	G4int &	var,
		G4String	name,
		G4String	description,
		bool	permitChange = true
	)			[protected]

argInt() declares a integer-valued argument. name should be a valid C identifier 15 chars or less, and description should be a short description (wrapWords() is used). Used only in the defineNamedArgs() function. permitChange affects whether this argument can be set when an element is placed.

References argFound, argMode, argName, argValue, CHANGE, commandName(), COUNT, BLEvaluator::evaluate(), HELP, nArgs, nFixed, PRINT, printArgDesc(), printArgString, printError(), PROCESS, and snprintf.

Referenced by BLCMDzntuple::defineNamedArgs(), BLCMDvirtualdetector::defineNamedArgs(), BLCMDtune::defineNamedArgs(), BLCMDtubs::defineNamedArgs(), BLCMDtrap::defineNamedArgs(), BLCMDtracker::defineNamedArgs(), BLCMDtrackcuts::defineNamedArgs(), BLCMDtrace::defineNamedArgs(), BLCMDtotalenergy::defineNamedArgs(), BLCMDtorus::defineNamedArgs(), BLCMDtimentuple::defineNamedArgs(), BLCMDstart::defineNamedArgs(), BLCMDsphere::defineNamedArgs(), BLCMDspacechargelw::defineNamedArgs(), BLCMDspacecharge::defineNamedArgs(), BLCMDsolenoid::defineNamedArgs(), BLCMDrfdevice::defineNamedArgs(), BLCMDreference::defineNamedArgs(), BLCMDprobefield::defineNamedArgs(), BLCMDprintfield::defineNamedArgs(), BLCMDpolycone::defineNamedArgs(), BLCMDplace::defineNamedArgs(), BLCMDpillbox::defineNamedArgs(), BLCMDphysics::defineNamedArgs(), BLCMDparticlesource::defineNamedArgs(), BLCMDparticlefilter::defineNamedArgs(), BLCMDntuple::defineNamedArgs(), BLCMDmultipole::defineNamedArgs(), BLCMDidealsectorbend::defineNamedArgs(), BLCMDhelicalharmonic::defineNamedArgs(), BLCMDgeometry::defineNamedArgs(), BLCMDgenericquad::defineNamedArgs(), BLCMDgenericbend::defineNamedArgs(), BLCMDg4ui::defineNamedArgs(), BLCMDfieldntuple::defineNamedArgs(), BLCMDfieldlines::defineNamedArgs(), BLCMDfieldexpr::defineNamedArgs(), BLCMDextrusion::defineNamedArgs(), BLCMDcosmicraybeam::defineNamedArgs(), BLCMDcoil::defineNamedArgs(), BLCMDbox::defineNamedArgs(), and BLCMDbeam::defineNamedArgs().

{
        switch(argMode) {
        case CHANGE:
                if(!permitChange) {
                        if(argName == name)
                                printError("%s: Argument '%s' is not permitted to change\n",
                                        commandName().c_str(),name.c_str());
                        break;
                }
                // flow into PROCESS
        case PROCESS:   
                if(argFound || argName != name) return;
                argFound = true;
                { BLEvaluator e;
                  G4double v = e.evaluate(argValue);
                  var = (G4int)(v+0.5);
                  if(e.status() != HepTool::Evaluator::OK ||
                                                        fabs(var-v) > 0.001) {
                          printError("Invalid value for argument '%s'"
                                " to command '%s'", argName.c_str(),
                                commandName().c_str());
                          return;
                  }
                }
/***
                { const char *p=argValue.c_str();
                  char *q;
                  G4int v = strtol(p,&q,0);
                  if(p == q || *q != '\0') {
                        printError("Invalid value for argument '%s'"
                                " to command '%s'", argName.c_str(),
                                commandName().c_str());
                        return;
                  }
                  var = v;
                }
***/
                break;
        case COUNT:
                ++nArgs;
                if(!permitChange) ++nFixed;
                break;
        case HELP:      
                printArgDesc(name,_description+(permitChange?"":" #"));
                break;
        case PRINT:
                { char tmp[65];
                  snprintf(tmp,sizeof(tmp),"%d",var);
                  printArgString += name;
                  printArgString += "=";
                  printArgString += tmp;
                  printArgString += "\n";
                }
                break;
        }
}

int BLCommand::handleNamedArgs

(

BLArgumentMap &

namedArgs

)

[protected]

handleNamedArgs() handles all named arguments to the command (i.e. those defined in defineNamedArgs()). For use in the command() function. returns 0 if OK, -1 on error.

Reimplemented in BLCMDplace.

References argChanged(), argFound, argMode, argName, argValue, commandName(), defineNamedArgs(), printError(), and PROCESS.

Referenced by BLCMDzntuple::command(), BLCMDvirtualdetector::command(), BLCMDusertrackfilter::command(), BLCMDtune::command(), BLCMDtubs::command(), BLCMDtrap::command(), BLCMDtrackermode::command(), BLCMDtrackerplane::command(), BLCMDtracker::command(), BLCMDtrackcuts::command(), BLCMDtrace::command(), BLCMDtotalenergy::command(), BLCMDtorus::command(), BLCMDtimentuple::command(), BLCMDstart::command(), BLCMDsphere::command(), BLCMDspacechargelw::command(), BLCMDspacecharge::command(), BLCMDsolenoid::command(), BLCMDrfdevice::command(), BLCMDreweightprocess::command(), BLCMDreference::command(), BLCMDprofile::command(), BLCMDprobefield::command(), BLCMDprintfield::command(), BLCMDprintf::command(), BLCMDpolycone::command(), BLCMDpillbox::command(), BLCMDphysics::command(), BLCMDparticlesource::command(), BLCMDparticlefilter::command(), BLCMDntuple::command(), BLCMDnewparticlentuple::command(), BLCMDmuminuscapturefix::command(), BLCMDmultipole::command(), BLCMDmovie::command(), BLCMDmaterial::command(), BLCMDlist::command(), BLCMDlilens::command(), BLCMDidealsectorbend::command(), BLCMDhelicalharmonic::command(), BLCMDhelicaldipole::command(), BLGroup::command(), BLCMDgeometry::command(), BLCMDgenericquad::command(), BLCMDgenericbend::command(), BLCMDg4ui::command(), BLCMDfieldntuple::command(), BLCMDfieldmap::command(), BLCMDfieldlines::command(), BLCMDfieldexpr::command(), BLCMDextrusion::command(), BLCMDeventcuts::command(), BLCMDdemo::command(), BLCMDcosmicraybeam::command(), BLCMDcornerarc::command(), BLCMDcorner::command(), BLCMDcollective::command(), BLCMDcoil::command(), BLCMDbug1021::command(), BLCMDbox::command(), BLCMDbeamlossntuple::command(), BLCMDbeam::command(), and BLCMDabsorber::command().

{
        int retval = 0;
        argMode = PROCESS;

        BLArgumentMap::iterator i;
        for(i=args.begin(); i!=args.end(); ++i) {
                argName = i->first;
                argValue = i->second;
                argFound = false;
                defineNamedArgs();
                if(!argFound) { 
                        printError("Invalid argument '%s' to command '%s'",
                                argName.c_str(),commandName().c_str());
                        retval = -1;
                }
        }

        if(args.size() > 0) argChanged();

        return retval;
}

void BLCommand::help

(

bool

detailed

)

[protected, virtual]

help() prints the help information for this command. detailed=false prints only the name and synopsis; true prints the description and arguments also.

Reimplemented in BLCMDbeamlossntuple, BLCMDmaterial, BLCMDnewparticlentuple, BLCMDparam, BLCMDphysics, BLCMDtimentuple, BLCMDtrace, BLCMDvirtualdetector, and BLCMDzntuple.

References argMode, commandName(), COUNT, defineNamedArgs(), description, BLNTuple::getFormatList(), HELP, IndentDesc(), nArgs, nFixed, nTunable, synopsis, and wrapWords().

Referenced by BLCMDzntuple::help(), BLCMDvirtualdetector::help(), BLCMDtrace::help(), BLCMDtimentuple::help(), BLCMDphysics::help(), BLCMDparam::help(), BLCMDnewparticlentuple::help(), BLCMDmaterial::help(), and BLCMDbeamlossntuple::help().

{
        G4String str(commandName());
        do { str += " "; } while(str.size() < IndentDesc.size());
        printf("%s%s\n",str.c_str(),synopsis.c_str());
        if(detailed) {
                if(description.rfind(": ") == description.size()-2)
                        description += BLNTuple::getFormatList(); 
                printf("\n%s",wrapWords(description,IndentDesc,IndentDesc).c_str());
                nArgs = nFixed = nTunable = 0;
                argMode = COUNT;
                defineNamedArgs();
                if(nArgs > 0) {
                        printf("\n%sNamed Arguments", IndentDesc.c_str());
                        if(nFixed > 0) 
                                printf(" (#=cannot be changed in place cmd)");
                        if(nTunable > 0) printf(" (@=Tunable)");
                        printf(":\n");
                        argMode = HELP;
                        defineNamedArgs();
                }
        }
}

G4String BLCommand::wrapWords	(	G4String	text,
		G4String	indent1,
		G4String	indent,
		G4String::size_type	width = 79
	)			[protected]

wrapWords() will wrap words for descriptions in help(). In text, lines beginning with whitespace are preserved as is, including blank lines. Otherwise, newlines aren't needed in text. indent1 is the start of the first line, and indent is used at the start of succeeding lines ("" is OK); indents are counted in the line width. The returned string always ends with "\n".

Referenced by help(), BLCMDlist::listParticleDetails(), print(), printArgDesc(), printArgs(), and BLCMDphysics::printCase().

{
        G4String retval(""), space(" "), line(""), word("");
        G4String::size_type pos=0, next=0;
        bool eol=false;

        while(pos < text.size()) {
                if(eol && isspace(text[pos])) {
                        next = text.find_first_of("\n",pos);
                        if(next == text.npos) next = text.size();
                        if(line.size() > 0) {retval += line; retval += "\n";}
                        line = indent + text.substr(pos,next-pos);
                        retval += line;
                        retval += "\n";
                        line = "";
                        pos = next + 1;
                        // eol = true;
                        continue;
                }
                next = text.find_first_of(" \t\r\n",pos);
                if(next == text.npos) {
                        word = text.substr(pos);
                        next = text.size();
                } else {
                        word = text.substr(pos,next-pos);
                        eol = (text[next] == '\n');
                }
                if(word.size() > 0) {
                        if(line.size() == 0) {
                                if(retval.size() == 0)
                                        line = indent1;
                                else
                                        line = indent;
                                line += word;
                        } else if(line.size()+word.size()+1 < width) {
                                line += space;
                                line += word;
                        } else {
                                retval += line;
                                retval += "\n";
                                line = indent;
                                line += word;
                        } 
                }
                pos = next + 1;
        } 
        if(line.size() > 0) {retval += line; retval += "\n";}

        return retval;
}

void BLCommand::printArgs

(

G4String

indent1

)

[protected]

printArgs() will print (to stdout) the named arguments of the command entered, for log purposes. Calls defineNamedArgs() with argMode=PRINT to print the args. indent1 is the indent for the first line.

References argMode, defineNamedArgs(), IndentArg(), PRINT, printArgString, and wrapWords().

Referenced by print().

{
        printArgString = "";
        argMode = PRINT;
        defineNamedArgs();
        printf("%s",wrapWords(printArgString,indent1,IndentArg).c_str());
}

virtual G4String BLCommand::commandName

(

)

[pure virtual]

commandName() returns the name of the command.

Implemented in BLCommandAlias, BLGroup, BLCMDabsorber, BLCMDbeam, BLCMDbeamlossntuple, BLCMDbox, BLCMDbug1021, BLCMDcoil, BLCMDcollective, BLCMDcorner, BLCMDcornerarc, BLCMDcosmicraybeam, BLCMDdefine, Macro, BLCMDdemo, BLCMDdo, BLCMDendgroup, BLCMDeventcuts, BLCMDexit, BLCMDextrusion, BLCMDfieldexpr, BLCMDfieldlines, BLCMDfieldmap, BLCMDfieldntuple, BLCMDg4ui, BLCMDgenericbend, BLCMDgenericquad, BLCMDgeometry, BLCMDhelicaldipole, BLCMDhelicalharmonic, BLCMDhelp, BLCMDidealsectorbend, BLCMDif, BLCMDinclude, BLCMDlilens, BLCMDlist, BLCMDmaterial, BLCMDmovie, BLCMDmultipole, BLCMDmuminuscapturefix, BLCMDnewparticlentuple, BLCMDntuple, BLCMDoutput, BLCMDparam, BLCMDparticlecolor, BLCMDparticlefilter, BLCMDparticlesource, BLCMDphysics, BLCMDpillbox, BLCMDplace, BLCMDpolycone, BLCMDprintf, BLCMDprintfield, BLCMDprobefield, BLCMDprofile, BLCMDrandomseed, BLCMDreference, BLCMDreweightprocess, BLCMDrfdevice, BLCMDsetdecay, BLCMDshowmaterial, BLCMDsolenoid, BLCMDspacecharge, BLCMDspacechargelw, BLCMDsphere, BLCMDstart, BLCMDtest, BLCMDtimentuple, BLCMDtorus, BLCMDtotalenergy, BLCMDtrace, BLCMDtrackcuts, BLCMDtracker, BLCMDtrackerplane, BLCMDtrackermode, BLCMDtrap, BLCMDtubs, BLCMDtune, BLCMDusertrackfilter, BLCMDvirtualdetector, and BLCMDzntuple.

Referenced by argDouble(), argInt(), argString(), BLCommandAlias::BLCommandAlias(), handleNamedArgs(), help(), print(), registerCommand(), and BLGroupElement::testGeometry().

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

command() executes the command associated with this element. argv and namedArgs come from parsing the command-line: argv has a vector of any positional arguments (without "="); namedArgs has a map of any named arguments of the form name=value. Returns 0 if OK, -1 on error. NOTE: for classes derived via BLElement.hh, arguments can be given when an object is defined and when it is placed. For that to work, argument values must not be used in the command() function unless they are defined with permitChange=false (in the above argString... functions). Also the correct units must be given to argDouble().

Implemented in BLCommandAlias, BLGroup, BLCMDabsorber, BLCMDbeam, BLCMDbeamlossntuple, BLCMDbox, BLCMDbug1021, BLCMDcoil, BLCMDcollective, BLCMDcorner, BLCMDcornerarc, BLCMDcosmicraybeam, BLCMDdefine, Macro, BLCMDdemo, BLCMDdo, BLCMDendgroup, BLCMDeventcuts, BLCMDexit, BLCMDextrusion, BLCMDfieldexpr, BLCMDfieldlines, BLCMDfieldmap, BLCMDfieldntuple, BLCMDg4ui, BLCMDgenericbend, BLCMDgenericquad, BLCMDgeometry, BLCMDhelicaldipole, BLCMDhelicalharmonic, BLCMDhelp, BLCMDidealsectorbend, BLCMDif, BLCMDinclude, BLCMDlilens, BLCMDlist, BLCMDmaterial, BLCMDmovie, BLCMDmultipole, BLCMDmuminuscapturefix, BLCMDnewparticlentuple, BLCMDntuple, BLCMDoutput, BLCMDparam, BLCMDparticlecolor, BLCMDparticlefilter, BLCMDparticlesource, BLCMDphysics, BLCMDpillbox, BLCMDplace, BLCMDpolycone, BLCMDprintf, BLCMDprintfield, BLCMDprobefield, BLCMDprofile, BLCMDrandomseed, BLCMDreference, BLCMDreweightprocess, BLCMDrfdevice, BLCMDsetdecay, BLCMDshowmaterial, BLCMDsolenoid, BLCMDspacecharge, BLCMDspacechargelw, BLCMDsphere, BLCMDstart, BLCMDtest, BLCMDtimentuple, BLCMDtorus, BLCMDtotalenergy, BLCMDtrace, BLCMDtrackcuts, BLCMDtracker, BLCMDtrackerplane, BLCMDtrackermode, BLCMDtrap, BLCMDtubs, BLCMDtune, BLCMDusertrackfilter, BLCMDvirtualdetector, and BLCMDzntuple.

Referenced by BLCommandAlias::command().

void BLCommand::defineNamedArgs

(

)

[virtual]

defineNamedArgs() defines the named arguments for the command. This function should consist ONLY of a series of calls to argString(), argDouble(), and argInt(). Used by handleNamedArgs(), help(), and print() (they manipulate the behavior of the argXXX() functions via argMode).

Reimplemented in BLGroup, BLCMDabsorber, BLCMDbeam, BLCMDbeamlossntuple, BLCMDbox, BLCMDbug1021, BLCMDcoil, BLCMDcollective, BLCMDcorner, BLCMDcornerarc, BLCMDcosmicraybeam, Macro, BLCMDdemo, BLCMDeventcuts, BLCMDextrusion, BLCMDfieldexpr, BLCMDfieldlines, BLCMDfieldmap, BLCMDfieldntuple, BLCMDg4ui, BLCMDgenericbend, BLCMDgenericquad, BLCMDgeometry, BLCMDhelicaldipole, BLCMDhelicalharmonic, BLCMDidealsectorbend, BLCMDlilens, BLCMDlist, BLCMDmaterial, BLCMDmovie, BLCMDmultipole, BLCMDmuminuscapturefix, BLCMDnewparticlentuple, BLCMDntuple, BLCMDparticlecolor, BLCMDparticlefilter, BLCMDparticlesource, BLCMDphysics, BLCMDpillbox, BLCMDplace, BLCMDpolycone, BLCMDprintf, BLCMDprintfield, BLCMDprobefield, BLCMDprofile, BLCMDrandomseed, BLCMDreference, BLCMDreweightprocess, BLCMDrfdevice, BLCMDsetdecay, BLCMDsolenoid, BLCMDspacecharge, BLCMDspacechargelw, BLCMDsphere, BLCMDstart, BLCMDtest, BLCMDtimentuple, BLCMDtorus, BLCMDtotalenergy, BLCMDtrace, BLCMDtrackcuts, BLCMDtracker, BLCMDtrackerplane, BLCMDtrackermode, BLCMDtrap, BLCMDtubs, BLCMDtune, BLCMDusertrackfilter, BLCMDvirtualdetector, and BLCMDzntuple.

References argMode, HELP, and IndentDesc().

Referenced by handleNamedArgs(), BLCMDplace::handleNamedArgs(), help(), and printArgs().

{
        if(argMode == HELP) printf("%s(none)\n",IndentDesc.c_str());
}

virtual void BLCommand::argChanged

(

)

[inline, virtual]

argChanged() will be called whenever some argument value has changed. Derived classes should define it and perform any internal computations that depend on argument values. Many/most derived classes won't need to use it. In particular, after argChanged() returns the functions getHeight(), getWidth() and getLength() must return the correct values for the current arguments. BEWARE: a single argument change may call this multiple times. Applies only to named arguments, not positional ones.

Reimplemented in BLCMDpillbox, BLCMDrfdevice, BLCMDtrackerplane, and BLCMDvirtualdetector.

Referenced by handleNamedArgs(), and BLCMDplace::handleNamedArgs().

{ }

void BLCommand::print

(

G4String

name

)

[virtual]

print() will print to stdout the command. The default versions will do for most commands and elements. name can be "". prints commandname() and name in the space of IndentArg, followed by the values of all named arguments, in the order they appear in defineNamedArgs().

References commandName(), IndentArg(), IndentDesc(), and printArgs().

Referenced by BLCMDzntuple::command(), BLCMDvirtualdetector::command(), BLCMDusertrackfilter::command(), BLCMDtune::command(), BLCMDtubs::command(), BLCMDtrap::command(), BLCMDtrackermode::command(), BLCMDtrackerplane::command(), BLCMDtracker::command(), BLCMDtrackcuts::command(), BLCMDtrace::command(), BLCMDtotalenergy::command(), BLCMDtorus::command(), BLCMDtimentuple::command(), BLCMDstart::command(), BLCMDsphere::command(), BLCMDspacechargelw::command(), BLCMDspacecharge::command(), BLCMDsolenoid::command(), BLCMDshowmaterial::command(), BLCMDsetdecay::command(), BLCMDrfdevice::command(), BLCMDreweightprocess::command(), BLCMDreference::command(), BLCMDprofile::command(), BLCMDprintf::command(), BLCMDpolycone::command(), BLCMDpillbox::command(), BLCMDphysics::command(), BLCMDparticlesource::command(), BLCMDparticlefilter::command(), BLCMDparticlecolor::command(), BLCMDntuple::command(), BLCMDnewparticlentuple::command(), BLCMDmuminuscapturefix::command(), BLCMDmultipole::command(), BLCMDmovie::command(), BLCMDlilens::command(), BLCMDidealsectorbend::command(), BLCMDhelicalharmonic::command(), BLCMDhelicaldipole::command(), BLGroup::command(), BLCMDgeometry::command(), BLCMDgenericquad::command(), BLCMDgenericbend::command(), BLCMDg4ui::command(), BLCMDfieldmap::command(), BLCMDfieldlines::command(), BLCMDfieldexpr::command(), BLCMDextrusion::command(), BLCMDeventcuts::command(), BLCMDcornerarc::command(), BLCMDcorner::command(), BLCMDcollective::command(), BLCMDbug1021::command(), BLCMDbox::command(), BLCMDbeamlossntuple::command(), and BLCMDabsorber::command().

{
        G4String indent1(commandName());
        do { indent1 += " "; } while(indent1.size() < IndentDesc.size());
        indent1 += name;
        do { indent1 += " "; } while(indent1.size() < IndentArg.size());
        printArgs(indent1);
}

void BLCommand::print	(	G4String	name,
		BLArgumentMap &	namedArgs
	)

Print() -- alternate version for commands with special arguments. does not use defineNamedArgs() to print arguments, but rather prints namedArgs.

References commandName(), IndentArg(), IndentDesc(), printArgString, and wrapWords().

{
        G4String indent1(commandName());
        do { indent1 += " "; } while(indent1.size() < IndentDesc.size());
        indent1 += name;
        do { indent1 += " "; } while(indent1.size() < IndentArg.size());
        printArgString = "";
        BLArgumentMap::iterator i;
        for(i=namedArgs.begin(); i!=namedArgs.end(); ++i) {
                printArgString += i->first;
                printArgString += "=";
                printArgString += i->second;
                printArgString += "\n";
        }
        printf("%s",wrapWords(printArgString,indent1,IndentArg).c_str());
}

virtual G4String BLCommand::getName

(

)

const [inline, virtual]

getName() returns the element's name; do not confuse this with commandName(). Re-defined by BLElement.

Reimplemented in BLElement, and BLCMDtracker.

{ return "??"; }

double BLCommand::undefined

(

)

[static]

undefined() returns a quiet Not-A-Number, for initializing arguments to determine if the user set them or not.

Referenced by BLCMDrfdevice::argChanged(), BLCMDrfdevice::BLCMDrfdevice(), RFdeviceField::reset(), RFdeviceField::RFdeviceField(), and RFdeviceField::UserSteppingAction().

{
        return gsl_nan();
}

bool BLCommand::isUndefined

(

double

v

)

[static]

isUndefined() determines wheter an argument has been set.

Referenced by RFdeviceField::addFieldValue(), BLCMDrfdevice::argChanged(), BLCMDrfdevice::BLCMDrfdevice(), BLCMDrfdevice::construct(), RFdeviceField::show1step(), and RFdeviceField::UserSteppingAction().

{
        return gsl_isnan(v);
}

BLCmdType BLCommand::getCmdType

(

)

[inline]

getCmdType() returns the type of this command

References type.

Referenced by BLCommandAlias::BLCommandAlias().

{ return type; }

static bool BLCommand::isValidCommand

(

G4String &

cmd

)

[inline, static]

isValidCommand() returns true if cmd is a valid command.

References mapCommand.

Referenced by main().

                { return mapCommand != 0 && mapCommand->count(cmd) > 0; }

int BLCommand::doCommand

(

G4String &

line

)

[static]

doCommand() will parse line and perform a single command. Returns 0 if OK, -1 if error.

References ARGNAME, ARGVALUE, nextToken(), NONE, parseArgs(), printError(), and type.

Referenced by BLCMDlist::command(), BLCMDif::command(), BLCMDdo::command(), Macro::command(), main(), and readFile().

{
        BLArgumentVector argv;
        BLArgumentMap namedArgs;
        G4String::size_type place = 0;
        TokenType type;

        if(line.size() < 1) return 0;
        char c = line.c_str()[0];
        if(c == '#') return 0;
        if(c == '*') {
                printf("%s\n",line.c_str());
                return 0;
        }
        if(c == '!') {
                printf("%s\n",line.c_str());
                fflush(stdout);
                system(line.c_str()+1);
                return 0;
        }
        if(c == '/') {
                printf("%s\n",line.c_str());
                G4UImanager* UI = G4UImanager::GetUIpointer();
                UI->ApplyCommand(line.c_str());
                return 0;
        }

        G4String cmd = nextToken(line,place,type);
        switch(type) {
        case NONE:
                return 0;       // line with only whitespace
        case ARGVALUE:
                break;
        case ARGNAME:
                printError("Syntax Error");
                return -1;
        }

        if(parseArgs(line.substr(place),argv,namedArgs) < 0)
                return -1;

        int retval;
        if((*mapCommand).count(cmd) > 0) {
                retval = (*mapCommand)[cmd]->command(argv,namedArgs);
        } else {
                retval = -1;
                printError("Unknown command '%s'",cmd.c_str());
        }

        return retval;
}

int BLCommand::parseArgs	(	const G4String &	line,
		BLArgumentVector &	argv,
		BLArgumentMap &	namedArgs
	)			[static]

parseArgs() will parse the arguments of a command line. Arguments are appended to argv[] and added to namedArgs. Returns 0 if OK, -1 if syntax error.

References ARGNAME, ARGVALUE, BLParam::expand(), nextToken(), NONE, Param, printError(), and type.

Referenced by BLCMDif::command(), doCommand(), BLFieldMap::readFile(), BLCoil::readMapFile(), and BLManager::setSteppingFormat().

{
        G4String::size_type place = 0;
        while(place < line.size()) {
                TokenType type;
                G4String arg = nextToken(line,place,type), val;
                switch(type) {
                case NONE:
                        break;
                case ARGNAME:
                        val = nextToken(line,place,type);
                        if(type != ARGVALUE) {
                                printError("Syntax Error");
                                return -1;
                        }
                        namedArgs[arg] = Param.expand(val);
                        break;
                case ARGVALUE:
                        argv.push_back(Param.expand(arg));
                        break;
                }
        }
        return 0;
}

int BLCommand::readFile

(

G4String

filename

)

[static]

readFile() reads a file of commands and executes them. "-" is stdin. Returns the number of errors encountered, or -1 if filename cannot be read.

References doCommand(), getErrorCount(), getNextCommand(), in, and printError().

Referenced by BLCMDinclude::command(), and main().

{
        std::istream *save = in;

        std::ifstream fin;
        if(filename == "-") {
                in = &std::cin;
        } else {
#ifdef WIN32
                fin.open(filename.c_str(),fin.in|fin.binary);
#else
                fin.open(filename.c_str());
#endif
                in = &fin;
        }
        if(in == 0 || !in->good()) {
                printError("Cannot open file '%s'",filename.c_str());
                return -1;
        }

        int errorCount = getErrorCount();

        while(in->good()) {
                G4String *line = getNextCommand();
                if(!line || line->find("exit") == 0) break;
                doCommand(*line);
        }

        fin.close();
        if(in == &std::cin) std::cout << std::endl;

        in = save;
        return getErrorCount() - errorCount;
}

void BLCommand::printError	(	const char *	fmt,
			...
	)			[static]

printError() prints an error message, using sprintf-style args. It also increments the errorCount.

References errors.

Referenced by BLCMDrfdevice::argChanged(), BLCMDpillbox::argChanged(), argDouble(), argDouble(), argInt(), argInt(), argString(), BLWindowShape::BLWindowShape(), BLCMDzntuple::callback(), BLCMDtrackermode::callback(), BLCMDtotalenergy::callback(), SetDecayInstance::callback(), BLCMDprintfield::callback(), BLCMDvirtualdetector::command(), BLCMDusertrackfilter::command(), BLCMDtune::command(), BLCMDtubs::command(), BLCMDtrap::command(), BLCMDtrackermode::command(), BLCMDtrackerplane::command(), BLCMDtracker::command(), BLCMDtrackcuts::command(), BLCMDtotalenergy::command(), BLCMDtorus::command(), BLCMDtimentuple::command(), BLCMDtest::command(), BLCMDsphere::command(), BLCMDspacechargelw::command(), BLCMDspacecharge::command(), BLCMDsolenoid::command(), BLCMDshowmaterial::command(), BLCMDsetdecay::command(), BLCMDrfdevice::command(), BLCMDreference::command(), BLCMDrandomseed::command(), BLCMDprofile::command(), BLCMDprobefield::command(), BLCMDprintfield::command(), BLCMDprintf::command(), BLCMDpolycone::command(), BLCMDplace::command(), BLCMDpillbox::command(), BLCMDphysics::command(), BLCMDparticlesource::command(), BLCMDparticlefilter::command(), BLCMDparticlecolor::command(), BLCMDoutput::command(), BLCMDntuple::command(), BLCMDnewparticlentuple::command(), BLCMDmuminuscapturefix::command(), BLCMDmultipole::command(), BLCMDmaterial::command(), BLCMDlilens::command(), BLCMDinclude::command(), BLCMDif::command(), BLCMDidealsectorbend::command(), BLCMDhelicalharmonic::command(), BLCMDhelicaldipole::command(), BLGroup::command(), BLCMDgenericquad::command(), BLCMDgenericbend::command(), BLCMDg4ui::command(), BLCMDfieldntuple::command(), BLCMDfieldmap::command(), BLCMDfieldlines::command(), BLCMDfieldexpr::command(), BLCMDextrusion::command(), BLCMDendgroup::command(), BLCMDdo::command(), Macro::command(), BLCMDdefine::command(), BLCMDcosmicraybeam::command(), BLCMDcornerarc::command(), BLCMDcorner::command(), BLCMDcoil::command(), BLCMDbox::command(), BLCMDbeamlossntuple::command(), BLCMDbeam::command(), BLCMDabsorber::command(), BLCMDvirtualdetector::construct(), BLCMDusertrackfilter::construct(), BLCMDtrackerplane::construct(), BLCMDparticlefilter::construct(), BLCMDgenericbend::construct(), BLNTuple::create(), BLTune::defineTunableArg(), BLCMDprintfield::do_cylinder(), BLCMDprintfield::do_grid(), BLCMDprintfield::do_points(), BLCMDprintfield::do_print(), doCommand(), BLParam::expand(), SetDecayInstance::fatalError(), FOR009NTuple::FOR009NTuple(), GenericBendField::GenericBendField(), GenericQuadField::GenericQuadField(), BLCoordinates::getCoordinateType(), BLParam::getInt(), getMaterial(), BLParam::getString(), getVisAttrib(), GridImpl::handleCommand(), handleNamedArgs(), BLCMDplace::handleNamedArgs(), BLCMDtracker::handlePreviousTracks(), BLCMDbeam::init(), BLCMDlist::listParticleDetails(), BLCMDfieldntuple::Loop::Loop(), MaterialFilter::MaterialFilter(), MultipoleField::MultipoleField(), BLCMDtrace::newTrace(), parseArgs(), BLGroup::placeElement(), BLFieldMap::readFile(), readFile(), BLCMDeventcuts::readFile(), BLCoil::readMapFile(), registerCommand(), CylinderImpl::setField(), GridImpl::setField(), setPos(), BLCMDpolycone::setup(), BLCMDextrusion::setup(), BLCMDcollective::setupFieldPoint(), BLCMDntuple::setupFirstEvent(), stringToRotationMatrix(), TrackerPlaneInstance::TrackerPlaneInstance(), BLTune::update(), and BLCMDprofile::Entry::UserZSteppingAction().

{
        va_list ap;
        va_start(ap,fmt);
        fprintf(stdout,"***");
        vfprintf(stdout,fmt,ap);
        fprintf(stdout,"\n");
        ++errors;
}

static int BLCommand::getErrorCount

(

)

[inline, static]

getErrorCount() will return the number of errors so far.

References errors.

Referenced by main(), and readFile().

{ return errors; }

G4String * BLCommand::getNextCommand

(

)

[static]

getNextCommand() returns the next command. backslash-newline has been handled, and the line is stripped of whitespace at both ends. returns 0 if error or EOF. The pointer should NOT be deleted.

References in, and BLSignal::setSignalReceived().

Referenced by BLCMDif::command(), BLCMDexit::command(), BLCMDdo::command(), and readFile().

{
        static G4String line;

        if(in == &std::cin) {
                BLSignal::setSignalReceived(true);
                std::cout << "cmd: ";
        }

        char tmp[1024+1];

        do {
                if(!in->good()) return 0;
                in->getline(tmp,sizeof(tmp));
                // trim trailing whitespace (handle "...\\ \r" from Windows)
                for(int i=strlen(tmp)-1; i>=0&&isspace(tmp[i]); --i)
                        tmp[i] = '\0';
                line = tmp;
        } while(line.size() == 0);

        // handle continuation lines (ending with \)
        while(line[line.size()-1] == '\\' && in->good()) {
                line[line.size()-1] = ' ';
                in->getline(tmp,sizeof(tmp));
                // trim trailing whitespace (handle "...\\ \r" from Windows)
                for(int i=strlen(tmp)-1; i>=0&&isspace(tmp[i]); --i)
                        tmp[i] = '\0';
                line += tmp;
        }

        if(in == &std::cin)
                BLSignal::setSignalReceived(false);

        // trim whitespace
        G4String::size_type i = line.find_first_not_of(" \t\r\n\v");
        if(i == line.npos) i = line.size();
        line.erase(0,i);
        while((i=line.find_last_of(" \t\r\n\v")) != line.npos) {
                if(i != line.size()-1) break;
                line.erase(i);
        }

        return &line;
}

BLCommandPos BLCommand::getPos

(

)

[static]

getPos() returns the current position of the Command input stream

References in.

Referenced by BLCMDdo::command().

{
        BLCommandPos pos(in);
        return pos;
}

void BLCommand::setPos

(

BLCommandPos &

pos

)

setPos() will set the Command input stream to a specified position

References BLCommandPos::in, in, BLCommandPos::pos, and printError().

Referenced by BLCMDdo::command().

{
        if(in != pos.in) {
                printError("Invalid BLCommand setPos()");
                return;
        }

        in->seekg(pos.pos);
}

G4Material * BLCommand::getMaterial	(	G4String	materialName,
		bool	error = true
	)			[static]

getMaterial() searches the G4Material list and returns the entry corresponding to name. Searches the NIST database if the material is not already defined. Prepends "G4_" if necessary. prints an error and exits if the material is not found, so all materials MUST be defined before they are used, unless they can be found in the geant4 NIST database.

References printError().

Referenced by BLCMDvirtualdetector::command(), BLCMDusertrackfilter::command(), BLCMDtubs::command(), BLCMDtrap::command(), BLCMDtrackerplane::command(), BLCMDtorus::command(), BLCMDsphere::command(), BLCMDshowmaterial::command(), BLCMDrfdevice::command(), BLCMDpolycone::command(), BLCMDpillbox::command(), BLCMDparticlefilter::command(), BLCMDmultipole::command(), BLCMDmaterial::command(), BLCMDlilens::command(), BLCMDidealsectorbend::command(), BLGroup::command(), BLCMDgenericquad::command(), BLCMDgenericbend::command(), BLCMDextrusion::command(), BLCMDcorner::command(), BLCMDcoil::command(), BLCMDbox::command(), BLCMDabsorber::command(), BLCMDvirtualdetector::construct(), BLCMDusertrackfilter::construct(), BLCMDtubs::construct(), BLCMDtrap::construct(), BLCMDtrackerplane::construct(), BLCMDtorus::construct(), BLCMDsphere::construct(), BLCMDsolenoid::construct(), BLCMDrfdevice::construct(), BLCMDpolycone::construct(), BLCMDpillbox::construct(), BLCMDparticlefilter::construct(), BLCMDmultipole::construct(), BLCMDlilens::construct(), BLCMDidealsectorbend::construct(), BLGroup::construct(), BLCMDgenericquad::construct(), BLCMDgenericbend::construct(), BLCMDextrusion::construct(), BLCMDcorner::construct(), BLCMDbox::construct(), and BLCMDabsorber::construct().

{
        const G4String G4("G4_");
        G4NistManager *m = G4NistManager::Instance();

        // first, check if it has already been constructed
        G4Material *mat = G4Material::GetMaterial(materialName,false);
        if(mat) return mat;
        mat = G4Material::GetMaterial(G4+materialName,false);
        if(mat) return mat;

        // Check for alias
        // NOTE: these materials are also listed in BLCMDmaterial::help()
        if(materialName == "Air") materialName = "AIR";
        if(materialName == "H2O") materialName = "WATER";
        if(materialName == "LH2") materialName = "lH2";
        if(materialName == "Vacuum") {
                // preserve the name "Vacuum" 
                G4Material *g = m->FindOrBuildMaterial("G4_Galactic");
                G4Material *v = new G4Material(materialName,
                        g->GetDensity(),1,g->GetState(),g->GetTemperature(),
                        g->GetPressure());
                v->AddMaterial(g,1.0);
                return v;
        }
        if(materialName == "Scintillator") {
                // preserve the name "Scintillator" 
                G4Material *g = m->FindOrBuildMaterial("G4_POLYSTYRENE");
                G4Material *v = new G4Material(materialName,
                        g->GetDensity(),1,g->GetState(),g->GetTemperature(),
                        g->GetPressure());
                v->AddMaterial(g,1.0);
                return v;
        }
        if(materialName == "Stainless304") {
                // ignore optional components < 1%
                G4Material *v = new G4Material(materialName,8.01*g/cm3,4,
                        kStateSolid);
                G4Material *Cr = m->FindOrBuildMaterial("G4_Cr");
                G4Material *Ni = m->FindOrBuildMaterial("G4_Ni");
                G4Material *Mn = m->FindOrBuildMaterial("G4_Mn");
                G4Material *Fe = m->FindOrBuildMaterial("G4_Fe");
                v->AddMaterial(Cr,0.19);
                v->AddMaterial(Ni,0.10);
                v->AddMaterial(Mn,0.01);
                v->AddMaterial(Fe,0.70);
                return v;
        }
        if(materialName == "Stainless316") {
                // ignore optional components < 1%
                G4Material *v = new G4Material(materialName,8.01*g/cm3,5,
                        kStateSolid);
                G4Material *Cr = m->FindOrBuildMaterial("G4_Cr");
                G4Material *Ni = m->FindOrBuildMaterial("G4_Ni");
                G4Material *Mn = m->FindOrBuildMaterial("G4_Mn");
                G4Material *Mo = m->FindOrBuildMaterial("G4_Mo");
                G4Material *Fe = m->FindOrBuildMaterial("G4_Fe");
                v->AddMaterial(Cr,0.18);
                v->AddMaterial(Ni,0.12);
                v->AddMaterial(Mn,0.01);
                v->AddMaterial(Mo,0.025);
                v->AddMaterial(Fe,0.665);
                return v;
        }
        if(materialName == "lHe" || materialName == "LHe") {
                G4Material *v = new G4Material(materialName,0.1249*g/cm3,1,
                        kStateLiquid);
                G4Material *He = m->FindOrBuildMaterial("G4_He");
                v->AddMaterial(He,1.0);
                return v;
        }

        // all materials in the database begin "G4_".
        if(materialName.find(G4) == 0)
                mat = m->FindOrBuildMaterial(materialName);
        else
                mat = m->FindOrBuildMaterial(G4+materialName);
        if(mat) return mat;
        if(!error) {
                printError("getMaterial: cannot find material '%s'",
                                                materialName.c_str());
                return getMaterial("Vacuum");
        }

        G4Exception("getMaterial","Material not found",FatalException,
                                                        materialName.c_str());
        return 0;
}

G4VisAttributes * BLCommand::getVisAttrib

(

G4String

color

)

[static]

getVisAttrib() returns the appropriate G4VisAttributes.

References getList(), and printError().

Referenced by BLCMDparticlecolor::BLCMDparticlecolor(), BLCMDshowmaterial::command(), BLCMDparticlecolor::command(), BLCMDvirtualdetector::construct(), BLCMDusertrackfilter::construct(), BLCMDtubs::construct(), BLCMDtrap::construct(), BLCMDtrackerplane::construct(), BLCMDtorus::construct(), BLCMDsphere::construct(), BLCMDsolenoid::construct(), BLCMDrfdevice::construct(), BLCMDpolycone::construct(), BLCMDparticlefilter::construct(), BLCMDmultipole::construct(), BLCMDlilens::construct(), BLCMDidealsectorbend::construct(), BLGroup::construct(), BLCMDgenericquad::construct(), BLCMDgenericbend::construct(), BLCMDextrusion::construct(), BLCMDcorner::construct(), BLCMDbox::construct(), BLCMDabsorber::construct(), and BLCMDfieldlines::generateOneFieldLine().

{
        G4VisAttributes *p=0;

        std::vector<G4double> v = getList(color,',');
        if(v.size() == 3) {
                p = new G4VisAttributes(true,G4Color(v[0],v[1],v[2]));
        } else if(v.size() == 4) {
                p = new G4VisAttributes(true,G4Color(v[0],v[1],v[2],v[3]));
        } else {
                p = new G4VisAttributes(G4VisAttributes::GetInvisible());
                if(color.size() > 0 && toupper(color.c_str()[0]) != 'I') {
                        printError("Invalid color '%s'",color.c_str());
                }
        }

        p->SetDaughtersInvisible(false);

        return p;
}

G4RotationMatrix * BLCommand::stringToRotationMatrix

(

G4String

rotation

)

[static]

stringToRotationMatrix() converts a string "X90,Y45" into a G4RotationMatrix. This is an active rotation, in that the object is first rotated around the parent's X axis by 90 degrees, then the object is further rotated around the parent's Y axis by 45 degrees. The return value points to a G4RotationMatrix on the heap, so it is persistent. Angles are in degrees, can have decimals, and can be negative. Axes are X, Y, Z. NOTE: This is expensive and should not be used during tracking.

References getDouble(), printError(), and splitString().

Referenced by BLCMDstart::command(), BLCMDreference::command(), BLCMDplace::command(), BLCMDcornerarc::command(), BLCMDcorner::command(), BLCMDbeam::command(), and BLCMDidealsectorbend::construct().

{
        // We apply successive rotations OF THE OBJECT around the FIXED
        // axes of the parent's local coordinates; rotations are applied
        // left-to-right (rotation="r1,r2,r3" => apply r1 then r2 then r3).
        G4RotationMatrix *rot = new G4RotationMatrix();
        std::vector<G4String> v = splitString(rotation,",",true);
        for(unsigned i=0; i<v.size(); ++i) {
                G4double angle=getDouble(v[i].substr(1)) * deg;
                if(gsl_isnan(angle)) {
                        printError("Invalid rotation specification '%s'",
                                                rotation.c_str());
                        return 0;
                }
                G4RotationMatrix thisRotation;
                switch(v[i].c_str()[0]) {
                case 'X': case 'x':
                        thisRotation = G4RotationMatrix(CLHEP::HepRotationX(angle));
                        break;
                case 'Y': case 'y':
                        thisRotation = G4RotationMatrix(CLHEP::HepRotationY(angle));
                        break;
                case 'Z': case 'z':
                        thisRotation = G4RotationMatrix(CLHEP::HepRotationZ(angle));
                        break;
                default:
                        printError("Invalid rotation specification '%s'",
                                                rotation.c_str());
                        return 0;
                }
                *rot = thisRotation * *rot;
        }

        return rot;
}

void BLCommand::dumpRotation	(	const G4RotationMatrix *	rot,
		const char *	str
	)			[static]

dumpRotation() dumps info about a rotation matrix to stdout. NOTE: This is expensive and should not be used during tracking.

Referenced by BLManager::displayGeometry().

{
        if(!rot) {
                printf("%s: no rotation\n",str);
                return;
        }
        G4ThreeVector x(1.0,0.0,0.0), z(0.0,0.0,1.0);
        G4ThreeVector rx = *rot * x;
        G4ThreeVector rz = *rot * z;
        printf("%s: %.3f,%.3f,%.3f / %.3f,%.3f,%.3f / %.3f,%.3f,%.3f\n",
                str,rot->xx(),rot->xy(),rot->xz(),rot->yx(),rot->yy(),rot->yz(),
                rot->zx(),rot->zy(),rot->zz());
        printf("        rot*x=%.3f,%.3f,%.3f   rot*z = %.3f,%.3f,%.3f\n",
                rx[0],rx[1],rx[2],rz[0],rz[1],rz[2]);
}

std::vector< G4String > BLCommand::splitString	(	const G4String &	s,
		const G4String &	delim,
		bool	trim = false
	)			[static]

splitString() splits a string at each instance of any character in delim, returning a vector<G4String>. If trim is true, each returned string has whitespace removed from its front and rear. Successive delimiters, or delimiters at the beginning or end, generate an empty string. NOTE: This is expensive and should not be used during tracking.

Referenced by AsciiNTuple::AsciiNTuple(), SetDecayInstance::callback(), BLCMDtrackcuts::command(), BLCMDtotalenergy::command(), BLCMDphysics::command(), getList(), SetDecayInstance::isMatch(), BLCMDlist::listParticleDetails(), matchList(), MaterialFilter::MaterialFilter(), BLCMDparticlefilter::setup(), BLCMDextrusion::setup(), and stringToRotationMatrix().

{
        G4String tmp(s), p;
        std::vector<G4String> v;
        while(tmp.size() > 0) {
                G4String::size_type i=tmp.find_first_of(delim);
                if(i > tmp.size()) i = tmp.size();
                p = tmp.substr(0,i);
                if(trim) {
                        while(p.size() > 0 && isspace(p.c_str()[0]))
                                p.erase(0,1);
                        while(p.size() > 0 && isspace(p.c_str()[p.size()-1]))
                                p.erase(p.size()-1,1);
                }
                v.push_back(p);
                tmp.erase(0,i+1);
        }

        return v;
}

static double BLCommand::getDouble

(

const G4String &

s

)

[inline, static]

getDouble() converts a string expression to a double, returning nan if the string is not a valid expression using double constants and standard C operators and functions; whitespace is permitted as in C but an empty or all-whitespace string is invalid. Callers can use std::isnan(double) or gsl_isnan(double) to test for validity. NOTE: This is expensive and should not be used during tracking.

References BLEvaluator::evaluate().

Referenced by getList(), and stringToRotationMatrix().

                { BLEvaluator e; return e.evaluate(s); }

std::vector< G4double > BLCommand::getList	(	const G4String &	s,
		const G4String &	delim
	)			[static]

getList() converts a string containing a delimited list of double expressions to a vector<G4double>. Any character in delim separates entries. Functions and operators known to BLEvaluator can be used in each entry of the list. Empty entries (null or consisting only of whitespace) are invalid. Returns an empty list if any entry is an invalid expression. NOTE: This is expensive and should not be used during tracking.

References getDouble(), and splitString().

Referenced by BLCMDzntuple::callback(), BLCMDprofile::command(), BLCMDprintf::command(), BLCMDfieldlines::command(), GenericBendField::GenericBendField(), GenericQuadField::GenericQuadField(), getVisAttrib(), BLCMDfieldntuple::Loop::Loop(), BLCMDpolycone::setup(), BLCMDextrusion::setup(), and BLCMDcollective::setupFieldPoint().

{
        std::vector<G4String> vect_s = splitString(s,delim,true);
        std::vector<G4double> retval;

        for(unsigned i=0; i<vect_s.size(); ++i) {
                G4double val=getDouble(vect_s[i]);
                if(gsl_isnan(val)) {
                        retval.clear();
                        break;
                }
                retval.push_back(val);
        }

        return retval;
}

bool BLCommand::matchList	(	const G4String	s,
		const G4String	patternList
	)			[static]

matchList() returns true if s matches any pattern in patternList, whch is a comma-separated list of file-glob patterns. NOTE: This is expensive and should not be used during tracking.

References fnmatch(), and splitString().

Referenced by BLCMDreweightprocess::isMatchingParticle(), and BLCMDreweightprocess::isMatchingProcess().

{
        std::vector<G4String> v = splitString(patternList,",",false);
        for(unsigned i=0; i<v.size(); ++i) {
                if(fnmatch(v[i].c_str(),s.c_str(),0) == 0)
                        return true;
        }

        return false;
}

---

Friends And Related Function Documentation

friend class BLCMDplace [friend]

friend class BLCMDhelp [friend]

---

Member Data Documentation

std::map< G4String, BLCommand * > * BLCommand::mapCommand [static, private]

Referenced by BLCMDhelp::command(), deleteCommand(), isValidCommand(), and registerCommand().

int BLCommand::errors = 0 [static, private]

Referenced by getErrorCount(), and printError().

std::istream * BLCommand::in = 0 [static, private]

Reimplemented in BLCMDprobefield.

Referenced by getNextCommand(), getPos(), BLCMDtracker::handlePreviousTracks(), readFile(), BLCMDeventcuts::readFile(), and setPos().

ArgumentMode BLCommand::argMode [protected]

Referenced by argDouble(), argInt(), argString(), argTunable(), defineNamedArgs(), BLCMDprintfield::defineNamedArgs(), handleNamedArgs(), BLCMDplace::handleNamedArgs(), help(), and printArgs().

bool BLCommand::argFound [protected]

Referenced by argDouble(), argInt(), argString(), argTunable(), handleNamedArgs(), and BLCMDplace::handleNamedArgs().

G4String BLCommand::argName [protected]

Referenced by argDouble(), argInt(), argString(), argTunable(), handleNamedArgs(), and BLCMDplace::handleNamedArgs().

G4String BLCommand::argValue [protected]

Referenced by argDouble(), argInt(), argString(), argTunable(), handleNamedArgs(), and BLCMDplace::handleNamedArgs().

G4String BLCommand::synopsis [protected]

Referenced by help(), and setSynopsis().

G4String BLCommand::description [protected]

Referenced by BLCMDntuple::BLCMDntuple(), help(), BLCMDzntuple::help(), BLCMDvirtualdetector::help(), BLCMDtrace::help(), BLCMDtimentuple::help(), BLCMDnewparticlentuple::help(), BLCMDmaterial::help(), BLCMDbeamlossntuple::help(), and setDescription().

G4String BLCommand::printArgString [protected]

Referenced by argDouble(), argInt(), argString(), argTunable(), print(), and printArgs().

int BLCommand::nArgs [protected]

Referenced by argDouble(), argInt(), argString(), argTunable(), and help().

int BLCommand::nFixed [protected]

Referenced by argDouble(), argInt(), argString(), and help().

int BLCommand::nTunable [protected]

Referenced by argTunable(), and help().

BLCmdType BLCommand::type [protected]

Reimplemented in BLCMDbeam, and BLCMDprintfield.

Referenced by BLCMDtrackcuts::command(), doCommand(), getCmdType(), parseArgs(), and registerCommand().

---

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

• BLCommand.hh
• BLCommand.cc