BLCMDprintf Class Reference

Inheritance diagram for BLCMDprintf:

List of all members.

---

Detailed Description

class BLCMDprintf will print track variables and expressions at a given z position.

Public Member Functions
	BLCMDprintf ()
	Constructor.
	BLCMDprintf (BLCMDprintf &r)
virtual G4String	commandName ()
	commandName() returns "printf".
virtual int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)
	command() implements the printf command.
virtual void	defineNamedArgs ()
	defineNamedArgs() defines the named arguments for this command.
void	UserZSteppingAction (const G4Track *track)
	UserZSteppingAction() from BLManager::ZSteppingAction.
virtual void	callback (int type)
	callback from BLCallback.
Private Attributes
G4String	z
G4String	zloop
G4String	require
G4String	file
G4String	format
G4double	noNewline
G4String	coordinates
BLCoordinateType	coordinateType
FILE *	fd
std::vector< G4String >	expr
BLEvaluator	eval
Static Private Attributes
static bool	init = true

---

Constructor & Destructor Documentation

BLCMDprintf::BLCMDprintf

(

)

Constructor.

References BLCMDTYPE_DATA, BLCOORD_CENTERLINE, coordinates, coordinateType, fd, file, format, noNewline, BLCommand::registerCommand(), require, BLCommand::setDescription(), BLCommand::setSynopsis(), z, and zloop.

Referenced by command().

                         : BLCommand(), BLManager::ZSteppingAction(), 
                                BLCallback(), expr(), eval()
{
        registerCommand(BLCMDTYPE_DATA);
        setSynopsis("prints track variables and expressions");
        setDescription("This is an interface to the C printf() function.\n"
                "The first positional argument is the format, and the "
                "following positional arguments are double expressions "
                "printed with the % fields in the format. Up to 16 "
                "expressions can be printed. The print is performed "
                "only if the 'required' expression is nonzero, as each "
                "track reaches one of the Z positions in the 'z' argument "
                "(centerline coordinates). Multiple printf commands "
                "with the same 'file' will be combined into the file "
                "as tracks reach any of their Z positions. More than 16 "
                "expressions can be broken into multiple printf-s with "
                "noNewline=1 for all but the last.\n\n"
                "The following variables can be used in expressions:\n"
                "   x,y,z,t,Px,Py,Pz\n"
                "   PDGid,EventID,TrackID,ParentId,Weight\n"
                "   Bx,By,Bz, Ex,Ey,Ez\n"
                "   tune (nonzero only for the Tune particle)\n"
                "   reference (nonzero only for the Reference particle)\n"
                "   beam (nonzero for any Beam particle)\n\n"
                "Each value in z and zloop can be an expression using double "
                "constants and the usual C operators and functions.\n\n"
                "Example:\n"
                " printf z=0 'Momentum is %.3f GeV/c' sqrt(Px*Px+Py*Py+Pz*Pz)/1000\n\n"
                "NOTE: if format begins 'Ptot=...' the parsing will think it is "
                "a named argument; put a space before the '=' to avoid that error."
        );

        z = "";
        zloop = "";
        require = "1";
        file = "";
        fd = stdout;
        format = "";
        noNewline = 0.0;
        coordinates = "Centerline";
        coordinateType = BLCOORD_CENTERLINE;
}

BLCMDprintf::BLCMDprintf

(

BLCMDprintf &

r

)

References coordinates, coordinateType, fd, file, format, noNewline, require, z, and zloop.

                                       : BLCommand(r), 
                BLManager::ZSteppingAction(r), BLCallback(), expr(), eval()
{
        z = r.z;
        zloop = r.zloop;
        require = r.require;
        file = r.file;
        fd = r.fd;
        format = r.format;
        noNewline = r.noNewline;
        coordinates = r.coordinates;
        coordinateType = r.coordinateType;
}

---

Member Function Documentation

virtual G4String BLCMDprintf::commandName

(

)

[inline, virtual]

commandName() returns "printf".

Implements BLCommand.

{ return "printf"; }

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

command() implements the printf command.

Implements BLCommand.

References BLCMDprintf(), coordinates, coordinateType, expr, fd, file, BLAsciiFile::fopen(), format, BLCoordinates::getCoordinateType(), BLCommand::getList(), BLManager::getObject(), BLCommand::handleNamedArgs(), init, BLCommand::print(), BLCommand::printError(), BLManager::registerCallback(), BLManager::registerZStep(), z, and zloop.

{
        BLCMDprintf *p = new BLCMDprintf(defaultPrintf);

        int retval = p->handleNamedArgs(namedArgs);

        p->coordinateType = BLCoordinates::getCoordinateType(p->coordinates);

        p->format = argv[0];
        for(unsigned i=1; i<argv.size(); ++i)
                p->expr.push_back(argv[i]);
        if(p->file != "") {
                p->fd = BLAsciiFile::fopen(p->file);
                if(!p->fd) {
                        printError("printf cannot write to file '%s'\n",
                                p->file.c_str());
                        p->fd = stdout;
                }
        }

        // register the z position(s) in the string z
        std::vector<G4double> vect = getList(p->z,",");
        if(vect.size() > 0) {
                for(unsigned i=0; i<vect.size(); ++i) {
                        BLManager::getObject()->registerZStep(vect[i],p,7);
                }
        } else if(p->z.size() > 0) {
                printError("printf: Syntax error in z");
        }

        // register the z position(s) in the string zloop
        vect = getList(p->zloop,",:");
        if(vect.size() == 3) {
                if(vect[2] < 1.0*mm || vect[0] > vect[1]) {
                        printError("printf: invalid zloop '%s'",
                                                        p->zloop.c_str());
                } else {
                        while(vect[0] <= vect[1]) {
                            BLManager::getObject()->registerZStep(vect[0],p,7);
                            vect[0] += vect[2];
                        }
                }
        } else if(p->zloop.size() > 0) {
                printError("printf: invalid zloop '%s'",p->zloop.c_str());
        }

        p->print("");

        if(init) {
                BLManager::getObject()->registerCallback(this,2);
                init = false;
        }

        return retval;
}

void BLCMDprintf::defineNamedArgs

(

)

[virtual]

defineNamedArgs() defines the named arguments for this command.

Reimplemented from BLCommand.

References BLCommand::argDouble(), BLCommand::argString(), coordinates, file, noNewline, require, z, and zloop.

{
        argString(z,"z","Comma-separated list of Z positions for printing (mm)");
        argString(zloop,"zloop","Loop in z, first:last:incr (mm)");
        argString(require,"require","logical expression for cutting (default=true)");
        argString(file,"file","Output filename (default=stdout)");
        argString(file,"filename","Synonym for file");
        argDouble(noNewline,"noNewline","set nonzero to omit final newline.");
        argString(coordinates,"coordinates","Coordinates: global, centerline, or reference (default=c).");
}

void BLCMDprintf::UserZSteppingAction

(

const G4Track *

track

)

[virtual]

UserZSteppingAction() from BLManager::ZSteppingAction.

Implements BLManager::ZSteppingAction.

References BEAM, BLCOORD_REFERENCE, coordinateType, eval, BLEvaluator::evaluate(), expr, fd, format, BLManager::getObject(), BLManager::getState(), MAX_EXPR, noNewline, REFERENCE, require, BLEvaluator::setTrackVariables(), and TUNE.

{
        BLManagerState state = BLManager::getObject()->getState();
        if(coordinateType == BLCOORD_REFERENCE && state != BEAM) return;

        eval.setTrackVariables(track,coordinateType,"",true);

        eval.setVariable("tune",state==TUNE ? 1.0 : 0.0);
        eval.setVariable("reference",state==REFERENCE ? 1.0 : 0.0);
        eval.setVariable("beam",state==BEAM ? 1.0 : 0.0);

        if(eval.evaluate(require) != 0.0) {
                double a[MAX_EXPR];
                for(unsigned i=0; i<MAX_EXPR; ++i) {
                        if(i<expr.size())
                                a[i] = eval.evaluate(expr[i]);
                        else
                                a[i] = 0.0;
                }
                fprintf(fd,format.c_str(),a[0],a[1],a[2],a[3],a[4],a[5],a[6],
                        a[7],a[8],a[9],a[10],a[11],a[12],a[13],a[14],a[15]);
                if(noNewline == 0.0) fprintf(fd,"\n");
        }
}

void BLCMDprintf::callback

(

int

type

)

[virtual]

callback from BLCallback.

Reimplemented from BLCallback.

References BLAsciiFile::fclose(), and fd.

{
        if(type != 2) return;
        BLAsciiFile::fclose(fd);
}

---

Member Data Documentation

G4String BLCMDprintf::z [private]

Referenced by BLCMDprintf(), command(), and defineNamedArgs().

G4String BLCMDprintf::zloop [private]

Referenced by BLCMDprintf(), command(), and defineNamedArgs().

G4String BLCMDprintf::require [private]

Referenced by BLCMDprintf(), defineNamedArgs(), and UserZSteppingAction().

G4String BLCMDprintf::file [private]

Referenced by BLCMDprintf(), command(), and defineNamedArgs().

G4String BLCMDprintf::format [private]

Referenced by BLCMDprintf(), command(), and UserZSteppingAction().

G4double BLCMDprintf::noNewline [private]

Referenced by BLCMDprintf(), defineNamedArgs(), and UserZSteppingAction().

G4String BLCMDprintf::coordinates [private]

Referenced by BLCMDprintf(), command(), and defineNamedArgs().

BLCoordinateType BLCMDprintf::coordinateType [private]

Referenced by BLCMDprintf(), command(), and UserZSteppingAction().

FILE* BLCMDprintf::fd [private]

Referenced by BLCMDprintf(), callback(), command(), and UserZSteppingAction().

std::vector<G4String> BLCMDprintf::expr [private]

Referenced by command(), and UserZSteppingAction().

BLEvaluator BLCMDprintf::eval [private]

Referenced by UserZSteppingAction().

bool BLCMDprintf::init = true [static, private]

Referenced by command().

---

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

• BLCMDprintf.cc