BLCMDendgroup Class Reference

Inheritance diagram for BLCMDendgroup:

List of all members.

---

Detailed Description

class BLCMDendgroup implements the endgroup command.

Public Member Functions
	BLCMDendgroup ()
G4String	commandName ()
int	command (BLArgumentVector &argv, BLArgumentMap &namedArgs)

---

Constructor & Destructor Documentation

BLCMDendgroup::BLCMDendgroup

(

)

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

{
        registerCommand(BLCMDTYPE_CONTROL);
        setSynopsis("ends a group definition.");
        setDescription("The group may then be placed as any other element.\n"
                "If the group was not given a length via an argument,\n"
                "endgroup computes the length and adjusts the offsets\n"
                "of all elements in the group so they refer to the center\n"
                "of the group.");
}

---

Member Function Documentation

G4String BLCMDendgroup::commandName

(

)

[inline, virtual]

Implements BLCommand.

{ return "endgroup"; }

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

Implements BLCommand.

References BLGroup::end(), BLGroup::getCurrent(), BLElement::getName(), BLGroup::getWorld(), BLGroup::height, BLGroup::length, BLCommand::printError(), and BLGroup::width.

{
        if(argv.size() != 0 || namedArgs.size() != 0) {
                printError("Invalid endgroup command");
                return -1;
        }

        BLGroup *c = BLGroup::getCurrent();
        if(c == BLGroup::getWorld()) {
                printError("Invalid endgroup command");
                return -1;
        }
        c->end();

        printf("endgroup %-6s length=%.1f width=%.1f height=%.1f\n",
                c->getName().c_str(),c->length,c->width,c->height);

        return 0;
}

---

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

• BLCMDendgroup.cc