G4tgrVolume Class Reference

#include <G4tgrVolume.hh>

Inheritance diagram for G4tgrVolume:

Public Member Functions
	G4tgrVolume ()
	G4tgrVolume (const std::vector< G4String > &wl)
	G4tgrVolume (const G4tgrVolume &vol)
virtual	~G4tgrVolume ()
virtual G4tgrPlace *	AddPlace (const std::vector< G4String > &wl)
G4tgrPlaceDivRep *	AddPlaceReplica (const std::vector< G4String > &wl)
G4tgrPlaceParameterisation *	AddPlaceParam (const std::vector< G4String > &wl)
void	AddVisibility (const std::vector< G4String > &wl)
void	AddRGBColour (const std::vector< G4String > &wl)
void	AddCheckOverlaps (const std::vector< G4String > &wl)
const G4String &	GetName () const
void	SetName (const G4String &name)
const G4String &	GetType () const
G4tgrSolid *	GetSolid () const
const G4String &	GetMaterialName () const
const std::vector< G4tgrPlace * >	GetPlacements () const
G4bool	GetVisibility () const
G4double *	GetColour () const
G4double *	GetRGBColour () const
G4bool	GetCheckOverlaps () const
virtual G4tgrVolume *	GetVolume (G4int ii) const

Protected Attributes
G4String	theName = ""
G4String	theType = ""
G4String	theMaterialName = ""
G4tgrSolid *	theSolid = nullptr
std::vector< G4tgrPlace * >	thePlacements
G4bool	theVisibility = false
G4double *	theRGBColour = nullptr
G4bool	theCheckOverlaps = false

Friends
std::ostream &	operator<< (std::ostream &os, const G4tgrVolume &obj)

Detailed Description

Definition at line 54 of file G4tgrVolume.hh.

Constructor & Destructor Documentation

G4tgrVolume() [1/3]

G4tgrVolume::G4tgrVolume

(

)

Definition at line 44 of file G4tgrVolume.cc.

{
}

Referenced by G4tgrVolume(), GetVolume(), and operator<<.

G4tgrVolume() [2/3]

G4tgrVolume::G4tgrVolume

(

const std::vector< G4String > &

wl

)

Definition at line 55 of file G4tgrVolume.cc.

{
  theType = "VOLSimple";
 
  //---------- set name
  theName = G4tgrUtils::GetString(wl[1]);
 
  theVisibility = true;
  theRGBColour  = new G4double[4];
  for(std::size_t ii = 0; ii < 4; ++ii)
  {
    theRGBColour[ii] = -1.;
  }
  theCheckOverlaps = false;
 
  if(wl.size() != 4)
  {
    //:VOLU tag to build a volume creating solid and material
    //---------- set material name
    theMaterialName = G4tgrUtils::GetString(wl[wl.size() - 1]);
 
    //---------- create only vector<double> of theSolidParams
    theSolid = G4tgrVolumeMgr::GetInstance()->CreateSolid(wl, 1);
 
#ifdef G4VERBOSE
    if(G4tgrMessenger::GetVerboseLevel() >= 1)
    {
      G4cout << "Created from new solid: " << *this << G4endl;
    }
#endif
  }
  else
  {
    //:VOLU tag to build a volume assigning material to solid
    //---------- set material name
    theMaterialName = G4tgrUtils::GetString(wl[3]);
    theSolid        = G4tgrVolumeMgr::GetInstance()->FindSolid(wl[2], true);
 
#ifdef G4VERBOSE
    if(G4tgrMessenger::GetVerboseLevel() >= 1)
    {
      G4cout << "Created from existing solid: " << *this << G4endl;
    }
#endif
  }
}

G4tgrVolume() [3/3]

G4tgrVolume::G4tgrVolume

(

const G4tgrVolume &

vol

)

Definition at line 103 of file G4tgrVolume.cc.

{
  theName          = vol.GetName();
  theType          = vol.GetType();
  theMaterialName  = vol.GetMaterialName();
  theSolid         = vol.GetSolid();
  thePlacements    = vol.GetPlacements();
  theVisibility    = vol.GetVisibility();
  theRGBColour     = vol.GetRGBColour();
  theCheckOverlaps = vol.GetCheckOverlaps();
}

~G4tgrVolume()

G4tgrVolume::~G4tgrVolume ( )

virtual

Definition at line 49 of file G4tgrVolume.cc.

{
  delete[] theRGBColour;
}

Member Function Documentation

AddCheckOverlaps()

void G4tgrVolume::AddCheckOverlaps

(

const std::vector< G4String > &

wl

)

------— Set check overlaps

Definition at line 251 of file G4tgrVolume.cc.

{
  //---------- Check for exact number of words read
  G4tgrUtils::CheckWLsize(wl, 3, WLSIZE_GE, " G4tgrVolume::AddCheckOverlaps");
 
  ///--------- Set check overlaps
  theCheckOverlaps = G4tgrUtils::GetBool(wl[2]);
}

AddPlace()

G4tgrPlace * G4tgrVolume::AddPlace ( const std::vector< G4String > & wl )

virtual

Reimplemented in G4tgrVolumeAssembly.

Definition at line 126 of file G4tgrVolume.cc.

{
  //---------- Check for exact number of words read
  G4tgrUtils::CheckWLsize(wl, 8, WLSIZE_EQ, " G4tgrVolume::AddPlace");
  //---------- set G4tgrPlace
  G4tgrPlaceSimple* pl = new G4tgrPlaceSimple(wl);
  //---------- check that there is no previous placement in
  //           the same parent with the same copyNo
  for(auto ite = thePlacements.cbegin(); ite != thePlacements.cend(); ++ite)
  {
    if(((*ite)->GetCopyNo() == pl->GetCopyNo()) &&
       ((*ite)->GetParentName() == pl->GetParentName()))
    {
      G4String ErrMessage =
        "Repeated placement. Volume " + theName + " in " + pl->GetParentName();
      G4Exception("G4tgrVolume::AddPlace()", "InvalidArgument",
                  FatalErrorInArgument, ErrMessage);
    }
  }
 
  pl->SetVolume(this);
  thePlacements.push_back(pl);
 
#ifdef G4VERBOSE
  if(G4tgrMessenger::GetVerboseLevel() >= 2)
  {
    G4cout << " G4tgrVolume:  New placement: " << thePlacements.size()
           << " added for Volume " << theName << " inside "
           << pl->GetParentName() << " type " << pl->GetType() << G4endl;
  }
#endif
  //---------- register parent - child
  G4tgrVolumeMgr::GetInstance()->RegisterParentChild(pl->GetParentName(), pl);
 
  return pl;
}

Referenced by G4tgrLineProcessor::ProcessLine().

AddPlaceParam()

G4tgrPlaceParameterisation * G4tgrVolume::AddPlaceParam

(

const std::vector< G4String > &

wl

)

Definition at line 201 of file G4tgrVolume.cc.

{
  //---------- set G4tgrPlaceParameterisation
  G4tgrPlaceParameterisation* pl = new G4tgrPlaceParameterisation(wl);
 
  pl->SetVolume(this);
  thePlacements.push_back(pl);
 
#ifdef G4VERBOSE
  if(G4tgrMessenger::GetVerboseLevel() >= 2)
  {
    G4cout << " G4tgrVolume:  New placement Param: " << thePlacements.size()
           << " added for Volume " << theName << " inside "
           << pl->GetParentName() << G4endl;
  }
#endif
  //---------- register parent - child
  G4tgrVolumeMgr::GetInstance()->RegisterParentChild(pl->GetParentName(), pl);
 
  return pl;
}

Referenced by G4tgrLineProcessor::ProcessLine().

AddPlaceReplica()

G4tgrPlaceDivRep * G4tgrVolume::AddPlaceReplica

(

const std::vector< G4String > &

wl

)

Definition at line 164 of file G4tgrVolume.cc.

{
  //---------- Check for exact number of words read
  G4tgrUtils::CheckWLsize(wl, 6, WLSIZE_GE, " G4tgrVolume::AddPlaceReplica");
  G4tgrUtils::CheckWLsize(wl, 7, WLSIZE_LE, " G4tgrVolume::AddPlaceReplica");
 
  if((wl.size() == 7) && (G4tgrUtils::GetDouble(wl[6]) != 0.) &&
     (wl[3] != "PHI"))
  {
    G4Exception("G4tgrVolume::AddPlaceReplica",
                "Offset set for replica not along PHI, it will not be used",
                JustWarning,
                G4String("Volume " + wl[1] + " in volume " + wl[2]).c_str());
  }
 
  //---------- set G4tgrPlace
  G4tgrPlaceDivRep* pl = new G4tgrPlaceDivRep(wl);
  pl->SetType("PlaceReplica");
  pl->SetVolume(this);
  thePlacements.push_back(pl);
 
#ifdef G4VERBOSE
  if(G4tgrMessenger::GetVerboseLevel() >= 2)
  {
    G4cout << " G4tgrVolume:  New placement replica: " << thePlacements.size()
           << " added for Volume " << theName << " inside "
           << pl->GetParentName() << G4endl;
  }
#endif
  //---------- register parent - child
  G4tgrVolumeMgr::GetInstance()->RegisterParentChild(pl->GetParentName(), pl);
 
  return pl;
}

Referenced by G4tgrLineProcessor::ProcessLine().

AddRGBColour()

void G4tgrVolume::AddRGBColour

(

const std::vector< G4String > &

wl

)

------— Set transparency

Definition at line 234 of file G4tgrVolume.cc.

{
  //---------- Check for exact number of words read
  G4tgrUtils::CheckWLsize(wl, 5, WLSIZE_GE, " G4tgrVolume::AddRGBColour");
 
  //---------- Set RGB colour
  theRGBColour[0] = G4tgrUtils::GetDouble(wl[2]);
  theRGBColour[1] = G4tgrUtils::GetDouble(wl[3]);
  theRGBColour[2] = G4tgrUtils::GetDouble(wl[4]);
  ///--------- Set transparency
  if(wl.size() == 6)
  {
    theRGBColour[3] = G4tgrUtils::GetDouble(wl[5]);
  }
}

AddVisibility()

void G4tgrVolume::AddVisibility

(

const std::vector< G4String > &

wl

)

Definition at line 224 of file G4tgrVolume.cc.

{
  //---------- Check for exact number of words read
  G4tgrUtils::CheckWLsize(wl, 3, WLSIZE_EQ, " G4tgrVolume::AddVisibility");
 
  //---------- Set visibility
  theVisibility = G4tgrUtils::GetBool(wl[2]);
}

GetCheckOverlaps()

G4bool G4tgrVolume::GetCheckOverlaps ( ) const

inline

Definition at line 94 of file G4tgrVolume.hh.

{ return theCheckOverlaps; }

Referenced by G4tgrVolume().

GetColour()

G4double * G4tgrVolume::GetColour ( ) const

inline

Definition at line 91 of file G4tgrVolume.hh.

{ return theRGBColour; }

GetMaterialName()

const G4String & G4tgrVolume::GetMaterialName ( ) const

inline

Definition at line 87 of file G4tgrVolume.hh.

{ return theMaterialName; }

Referenced by G4tgrVolume().

GetName()

const G4String & G4tgrVolume::GetName ( ) const

inline

Definition at line 83 of file G4tgrVolume.hh.

{ return theName; }

Referenced by G4tgbDetectorConstruction::Construct(), G4tgbDetectorBuilder::ConstructDetector(), G4tgbVolume::ConstructG4Volumes(), G4tgrVolumeMgr::DumpSummary(), G4tgrVolumeMgr::DumpVolumeLeaf(), G4tgrVolume(), G4tgrVolumeMgr::GetTopVolume(), G4tgrVolumeMgr::RegisterMe(), and G4tgrVolumeMgr::UnRegisterMe().

GetPlacements()

const std::vector< G4tgrPlace * > G4tgrVolume::GetPlacements ( ) const

inline

Definition at line 89 of file G4tgrVolume.hh.

{return thePlacements;}

Referenced by G4tgrVolume(), and G4tgrVolumeMgr::GetTopVolume().

GetRGBColour()

G4double * G4tgrVolume::GetRGBColour ( ) const

inline

Definition at line 92 of file G4tgrVolume.hh.

{ return theRGBColour; }

Referenced by G4tgrVolume().

GetSolid()

G4tgrSolid * G4tgrVolume::GetSolid ( ) const

inline

Definition at line 86 of file G4tgrVolume.hh.

{ return theSolid; }

Referenced by G4tgrSolidBoolean::G4tgrSolidBoolean(), G4tgrSolidMultiUnion::G4tgrSolidMultiUnion(), G4tgrSolidScaled::G4tgrSolidScaled(), and G4tgrVolume().

GetType()

const G4String & G4tgrVolume::GetType ( ) const

inline

Definition at line 85 of file G4tgrVolume.hh.

{ return theType; }

Referenced by G4tgrLineProcessor::FindVolume(), G4tgrVolume(), and G4tgrVolumeMgr::GetTopVolume().

GetVisibility()

G4bool G4tgrVolume::GetVisibility ( ) const

inline

Definition at line 90 of file G4tgrVolume.hh.

{ return theVisibility; }

Referenced by G4tgrVolume().

GetVolume()

G4tgrVolume * G4tgrVolume::GetVolume ( G4int ii ) const

virtual

Definition at line 116 of file G4tgrVolume.cc.

{
  G4String ErrMessage = "Should only be called for composite solids... " +
                        G4UIcommand::ConvertToString(ii);
  G4Exception("G4tgrVolume::GetVolume()", "InvalidCall", FatalException,
              ErrMessage);
  return nullptr;
}

SetName()

void G4tgrVolume::SetName ( const G4String & name )

inline

Definition at line 84 of file G4tgrVolume.hh.

{ theName = name; }

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, const G4tgrVolume & obj )

friend

Definition at line 261 of file G4tgrVolume.cc.

{
  os << "G4tgrVolume= " << obj.theName << " Type= " << obj.theType
     << " Material= " << obj.theMaterialName << " Visibility "
     << obj.theVisibility << " Colour " << (obj.theRGBColour)[0] << " "
     << (obj.theRGBColour)[1] << " " << (obj.theRGBColour)[2] << " "
     << (obj.theRGBColour)[3] << " "
     << " CheckOverlaps " << obj.theCheckOverlaps << " N placements "
     << obj.thePlacements.size() << G4endl;
 
  return os;
}

Member Data Documentation

theCheckOverlaps

G4bool G4tgrVolume::theCheckOverlaps = false

protected

Definition at line 115 of file G4tgrVolume.hh.

Referenced by AddCheckOverlaps(), G4tgrVolume(), G4tgrVolume(), GetCheckOverlaps(), and operator<<.

theMaterialName

G4String G4tgrVolume::theMaterialName = ""

protected

Definition at line 106 of file G4tgrVolume.hh.

Referenced by G4tgrVolume(), G4tgrVolume(), G4tgrVolumeDivision::G4tgrVolumeDivision(), GetMaterialName(), and operator<<.

theName

G4String G4tgrVolume::theName = ""

protected

Definition at line 102 of file G4tgrVolume.hh.

Referenced by AddPlace(), G4tgrVolumeAssembly::AddPlace(), AddPlaceParam(), AddPlaceReplica(), G4tgrVolume(), G4tgrVolume(), G4tgrVolumeAssembly::G4tgrVolumeAssembly(), G4tgrVolumeDivision::G4tgrVolumeDivision(), GetName(), operator<<, G4tgrVolumeAssembly::operator<<, G4tgrVolumeDivision::operator<<, and SetName().

thePlacements

std::vector<G4tgrPlace*> G4tgrVolume::thePlacements

protected

Definition at line 110 of file G4tgrVolume.hh.

Referenced by AddPlace(), G4tgrVolumeAssembly::AddPlace(), AddPlaceParam(), AddPlaceReplica(), G4tgrVolume(), GetPlacements(), and operator<<.

theRGBColour

G4double* G4tgrVolume::theRGBColour = nullptr

protected

Definition at line 114 of file G4tgrVolume.hh.

Referenced by AddRGBColour(), G4tgrVolume(), G4tgrVolume(), G4tgrVolumeAssembly::G4tgrVolumeAssembly(), G4tgrVolumeDivision::G4tgrVolumeDivision(), GetColour(), GetRGBColour(), operator<<, and ~G4tgrVolume().

theSolid

G4tgrSolid* G4tgrVolume::theSolid = nullptr

protected

Definition at line 108 of file G4tgrVolume.hh.

Referenced by G4tgrVolume(), G4tgrVolume(), G4tgrVolumeAssembly::G4tgrVolumeAssembly(), G4tgrVolumeDivision::G4tgrVolumeDivision(), and GetSolid().

theType

G4String G4tgrVolume::theType = ""

protected

Definition at line 104 of file G4tgrVolume.hh.

Referenced by G4tgrVolume(), G4tgrVolume(), G4tgrVolumeAssembly::G4tgrVolumeAssembly(), G4tgrVolumeDivision::G4tgrVolumeDivision(), GetType(), and operator<<.

theVisibility

G4bool G4tgrVolume::theVisibility = false

protected

Definition at line 113 of file G4tgrVolume.hh.

Referenced by AddVisibility(), G4tgrVolume(), G4tgrVolume(), G4tgrVolumeAssembly::G4tgrVolumeAssembly(), G4tgrVolumeDivision::G4tgrVolumeDivision(), GetVisibility(), and operator<<.

---

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

• G4tgrVolume.hh
• G4tgrVolume.cc