BLGroupElement Class Reference

#include <BLGroupElement.hh>

Inheritance diagram for BLGroupElement:

List of all members.

---

Detailed Description

BLGroupElement - Base class for BLElement-s that can contain other BLElement-s.

Public Member Functions
	BLGroupElement ()
	Default Constructor.
	BLGroupElement (const BLGroupElement &r)
	Copy Constructor for a BLGroupElement.
	~BLGroupElement ()
	Destructor.
void	setName (G4String _name)
	setName() adds this BLGroupElement to mapGroupElement; calls BLElement::setName().
int	getNChildren ()
	getNChildren() returns the number of children.
virtual void	constructChildren (G4LogicalVolume *parent, G4String parentName, G4RotationMatrix *parentRotation, G4ThreeVector parentPosition)
	constructChildren() will construct the children The enclosing BLGroupElement must already be constructed, so this is normally called at the end of construct().
virtual void	placeChild (BLElement *element, G4RotationMatrix *rot, G4ThreeVector &offset, G4String rename)
	placeChild() will place a child within this GroupElement. The object being placed is rotated wrt the fixed axes of the group's local coordinates.
int	testGeometry (int npoints, G4double tolerance, bool visual=false, G4RotationMatrix rotation=G4RotationMatrix(), G4ThreeVector offset=G4ThreeVector())
	testGeometry() will check that all children are inside this element, and that no children intersect each other. It then calls testGeometry() for any children that are GroupElement-s. npoints is the # of points per child to test. returns the number of errors detected.
virtual G4bool	isGroupElement ()
	isGroupElement() returns true if this is a BLGroupElement.
virtual G4bool	isWithin (G4ThreeVector &local, G4double tolerance)=0
	isWithin() tests that a point is within this element, or is within tolerance of being inside. local[] is in local coordinates of this element.
Static Public Member Functions
static BLGroupElement *	find (G4String name)
	find() will find a GroupElement by name
Private Member Functions
BLGroupElement &	operator= (const BLGroupElement &)
Private Attributes
std::vector< Child >	child
Static Private Attributes
static std::map< G4String, BLGroupElement * >	mapGroupElement
Friends
class	BLGroup
Classes
struct	Child

---

Constructor & Destructor Documentation

BLGroupElement::BLGroupElement

(

)

[inline]

Default Constructor.

: BLElement(), child() { }

BLGroupElement::BLGroupElement

(

const BLGroupElement &

r

)

[inline]

Copy Constructor for a BLGroupElement.

: BLElement(r), child(r.child) { }

BLGroupElement::~BLGroupElement

(

)

[inline]

Destructor.

{ }

---

Member Function Documentation

BLGroupElement& BLGroupElement::operator=

(

const BLGroupElement &

)

[private]

void BLGroupElement::setName

(

G4String

_name

)

[virtual]

setName() adds this BLGroupElement to mapGroupElement; calls BLElement::setName().

Reimplemented from BLElement.

References mapGroupElement, and BLElement::setName().

Referenced by BLCMDtubs::command(), BLCMDtrap::command(), BLCMDtorus::command(), BLCMDsphere::command(), BLCMDpolycone::command(), BLGroup::command(), BLCMDgenericbend::command(), BLCMDextrusion::command(), BLCMDbox::command(), BLCMDabsorber::command(), and BLGroup::getWorld().

{
        mapGroupElement[_name] = this;
        BLElement::setName(_name);
}

int BLGroupElement::getNChildren

(

)

[inline]

getNChildren() returns the number of children.

References child.

Referenced by BLCMDgenericbend::construct(), and BLCMDgenericbend::isOK().

{ return child.size(); }

void BLGroupElement::constructChildren	(	G4LogicalVolume *	parent,
		G4String	parentName,
		G4RotationMatrix *	parentRotation,
		G4ThreeVector	parentPosition
	)			[virtual]

constructChildren() will construct the children The enclosing BLGroupElement must already be constructed, so this is normally called at the end of construct().

References child, BLElement::construct(), BLElement::getName(), NO_RENAME(), and BLElement::setName().

Referenced by BLCMDtubs::construct(), BLCMDtrap::construct(), BLCMDtorus::construct(), BLCMDsphere::construct(), BLCMDpolycone::construct(), BLGroup::construct(), BLCMDgenericbend::construct(), BLCMDextrusion::construct(), BLCMDbox::construct(), and BLCMDabsorber::construct().

{
        static int level=0;

        if(++level > 64) {
                G4Exception("BLGroupElement","Nesting > 64",FatalException, "");
        }

        int counter = 1;
        std::vector<Child>::iterator i;
        for(i=child.begin(); i!=child.end(); ++i) {
                BLElement *e = i->element;
                G4String savename = e->getName();
                G4String pname = parentName;
                // handle i->rename
                if(i->rename != NO_RENAME) {
                        if(i->rename.find('+') == 0) {
                                e->setName(i->rename.substr(1));
                        } else {
                                e->setName(i->rename);
                                pname = "";
                        }
                }
                // handle '#' in name
                G4String::size_type j = e->getName().find('#');
                if(j != e->getName().npos) {
                        char tmp[32];
                        sprintf(tmp,"%d",counter++);
                        G4String tmpname(e->getName());
                        tmpname.replace(j,1,tmp);
                        e->setName(tmpname);
                }
                e->construct(&i->rot,i->offset,parent,pname,parentRotation,
                                                        parentPosition);
                e->setName(savename);
        }

        --level;
}

void BLGroupElement::placeChild	(	BLElement *	element,
		G4RotationMatrix *	rot,
		G4ThreeVector &	offset,
		G4String	rename
	)			[virtual]

placeChild() will place a child within this GroupElement. The object being placed is rotated wrt the fixed axes of the group's local coordinates.

References child, BLGroupElement::Child::element, BLGroupElement::Child::offset, BLGroupElement::Child::rename, and BLGroupElement::Child::rot.

Referenced by BLCMDplace::command().

{
        Child c;
        c.element = element;
        c.rename = rename;
        if(rot) c.rot = *rot;
        c.offset = offset;
        child.push_back(c);
}

int BLGroupElement::testGeometry	(	int	npoints,
		G4double	tolerance,
		bool	visual = false,
		G4RotationMatrix	rotation = G4RotationMatrix(),
		G4ThreeVector	offset = G4ThreeVector()
	)

testGeometry() will check that all children are inside this element, and that no children intersect each other. It then calls testGeometry() for any children that are GroupElement-s. npoints is the # of points per child to test. returns the number of errors detected.

References child, BLCommand::commandName(), BLElement::generatePoints(), BLElement::getName(), BLElement::isGroupElement(), BLElement::isOutside(), isWithin(), NO_RENAME(), and testGeometry().

Referenced by BLCMDgeometry::callback(), and testGeometry().

{
        // no sense testing an empty group
        if(child.size() == 0) return 0;

        printf("Testing geometry for children of %s '%s':\n",
                commandName().c_str(), getName().c_str());

        int err = 0;
        std::vector<G4ThreeVector> points;
        G4RotationMatrix inverse=rotation.inverse();
        int icounter = 1;
        std::vector<Child>::iterator i;
        for(i=child.begin(); i!=child.end(); ++i) {
                BLElement *ie = i->element;
                G4String iname = ie->getName();
                // handle i->rename
                if(i->rename != NO_RENAME)
                        iname = i->rename;
                // handle '#' in iname
                G4String::size_type k = iname.find('#');
                if(k != iname.npos) {
                        char tmp[32];
                        sprintf(tmp,"%d",icounter++);
                        iname.replace(k,1,tmp);
                }
                ie->generatePoints(npoints,points);
                // convert local coords of ie to local coords of this
                bool isRotated = !i->rot.isIdentity();
                for(k=0; k<points.size(); ++k) {
                        if(isRotated) points[k] = i->rot * points[k];
                        points[k] += i->offset;
                }
                G4VVisManager* visMgr = G4VVisManager::GetConcreteInstance(); 
                if(visual && visMgr) {
                        for(k=0; k<points.size(); ++k) {
                                G4ThreeVector pos = points[k];
                                pos = inverse * pos + offset; // local->global
                                G4Circle circle(pos);
                                circle.SetScreenDiameter(1.0);
                                circle.SetFillStyle(G4Circle::filled);
                                G4Colour colour(1.,0.,0.);
                                G4VisAttributes attribs(colour);
                                circle.SetVisAttributes(attribs);
                                visMgr->Draw(circle);
                        }
                }
                for(k=0; k<points.size(); ++k) {
                        if(!isWithin(points[k],tolerance)) {
                                printf("*** %s '%s' extends outside %s '%s'\n",
                                        ie->commandName().c_str(),
                                        iname.c_str(),
                                        commandName().c_str(),
                                        getName().c_str());
                                ++err;
                                break;
                        }
                }
                int jcounter = 1;
                std::vector<Child>::iterator j;
                for(j=child.begin(); j!=child.end(); ++j) {
                        if(j == i) continue;
                        BLElement *je = j->element;
                        G4String jname = je->getName();
                        // handle j->rename
                        if(j->rename != NO_RENAME)
                                jname = j->rename;
                        // handle '#' in jname
                        G4String::size_type k = jname.find('#');
                        if(k != jname.npos) {
                                char tmp[32];
                                sprintf(tmp,"%d",jcounter++);
                                jname.replace(k,1,tmp);
                        }
                        isRotated = !j->rot.isIdentity();
                        for(k=0; k<points.size(); ++k) {
                                G4ThreeVector pt = points[k] - j->offset;
                                if(isRotated) pt = j->rot.inverse() * pt;
                                if(!je->isOutside(pt,tolerance)) {
                                    printf("*** %s '%s' intersects %s '%s'\n",
                                        ie->commandName().c_str(),
                                        iname.c_str(),
                                        je->commandName().c_str(),
                                        jname.c_str());
                                    ++err;
                                    break;
                                }
                        }
                }
        }
        for(i=child.begin(); i!=child.end(); ++i) {
                BLElement *ie = i->element;
                if(!ie->isGroupElement()) continue;
                BLGroupElement *ge = (BLGroupElement*)ie;
                if(ge) {
                        G4ThreeVector off = offset + rotation.inverse() * i->offset;
                        G4RotationMatrix rot = i->rot.inverse() * rotation;
                        err += ge->testGeometry(npoints,tolerance,visual,
                                                                rot,off);
                }
        }

        return err;
}

virtual G4bool BLGroupElement::isGroupElement

(

)

[inline, virtual]

isGroupElement() returns true if this is a BLGroupElement.

Reimplemented from BLElement.

{ return true; }

virtual G4bool BLGroupElement::isWithin	(	G4ThreeVector &	local,
		G4double	tolerance
	)			[pure virtual]

isWithin() tests that a point is within this element, or is within tolerance of being inside. local[] is in local coordinates of this element.

Implemented in BLGroup, BLCMDabsorber, BLCMDbox, BLCMDextrusion, BLCMDgenericbend, BLCMDpolycone, BLCMDsphere, BLCMDtorus, BLCMDtrap, and BLCMDtubs.

Referenced by testGeometry().

BLGroupElement * BLGroupElement::find

(

G4String

name

)

[static]

find() will find a GroupElement by name

Reimplemented from BLElement.

References mapGroupElement.

Referenced by BLCMDplace::command().

{
        return mapGroupElement[_name];
}

---

Friends And Related Function Documentation

friend class BLGroup [friend]

---

Member Data Documentation

std::vector<Child> BLGroupElement::child [private]

Referenced by constructChildren(), BLGroup::end(), getNChildren(), placeChild(), BLGroup::placeElement(), and testGeometry().

std::map< G4String, BLGroupElement * > BLGroupElement::mapGroupElement [static, private]

Referenced by find(), and setName().

---

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

• BLGroupElement.hh
• BLGroupElement.cc