GGEMS  1.1
GPU GEant4-based Monte Carlo Simulations
GGEMSBox Class Reference

Class GGEMSBox inheriting from GGEMSVolume handling Box solid. More...

#include "GGEMSBox.hh"

Inheritance diagram for GGEMSBox:
Inheritance graph
Collaboration diagram for GGEMSBox:
Collaboration graph

Public Member Functions

 GGEMSBox (GGfloat const &width, GGfloat const &height, GGfloat const &depth, std::string const &unit="mm")
 GGEMSBox constructor. More...
 
 ~GGEMSBox (void)
 GGEMSBox destructor. More...
 
 GGEMSBox (GGEMSBox const &box)=delete
 Avoid copy of the class by reference. More...
 
GGEMSBoxoperator= (GGEMSBox const &box)=delete
 Avoid assignement of the class by reference. More...
 
 GGEMSBox (GGEMSBox const &&box)=delete
 Avoid copy of the class by rvalue reference. More...
 
GGEMSBoxoperator= (GGEMSBox const &&box)=delete
 Avoid copy of the class by rvalue reference. More...
 
void Initialize (void) override
 Initialize the solid and store it in Phantom creator manager. More...
 
void Draw (void) override
 Draw analytical volume in voxelized phantom. More...
 
- Public Member Functions inherited from GGEMSVolume
 GGEMSVolume (void)
 GGEMSVolume constructor. More...
 
virtual ~GGEMSVolume (void)
 GGEMSVolume destructor. More...
 
 GGEMSVolume (GGEMSVolume const &volume)=delete
 Avoid copy of the class by reference. More...
 
GGEMSVolumeoperator= (GGEMSVolume const &volume)=delete
 Avoid assignement of the class by reference. More...
 
 GGEMSVolume (GGEMSVolume const &&volume)=delete
 Avoid copy of the class by rvalue reference. More...
 
GGEMSVolumeoperator= (GGEMSVolume const &&volume)=delete
 Avoid copy of the class by rvalue reference. More...
 
void SetLabelValue (GGfloat const &label_value)
 Set the label value. More...
 
void SetPosition (GGfloat const &pos_x, GGfloat const &pos_y, GGfloat const &pos_z, std::string const &unit="mm")
 Set the solid phantom position. More...
 
void SetMaterial (std::string const &material)
 set the material, Air by default More...
 

Private Attributes

GGfloat height_
 
GGfloat width_
 
GGfloat depth_
 

Additional Inherited Members

- Protected Attributes inherited from GGEMSVolume
GGfloat label_value_
 
GGfloat3 positions_
 
cl::Kernel ** kernel_draw_volume_
 

Detailed Description

Class GGEMSBox inheriting from GGEMSVolume handling Box solid.

Definition at line 40 of file GGEMSBox.hh.

Constructor & Destructor Documentation

◆ GGEMSBox() [1/3]

GGEMSBox::GGEMSBox ( GGfloat const &  width,
GGfloat const &  height,
GGfloat const &  depth,
std::string const &  unit = "mm" 
)

GGEMSBox constructor.

Parameters
width- Width of the box
height- Height of the box
depth- Depth of the box
unit- Unit of distance

Definition at line 40 of file GGEMSBox.cc.

◆ ~GGEMSBox()

GGEMSBox::~GGEMSBox ( void  )

GGEMSBox destructor.

Definition at line 56 of file GGEMSBox.cc.

◆ GGEMSBox() [2/3]

GGEMSBox::GGEMSBox ( GGEMSBox const &  box)
delete

Avoid copy of the class by reference.

Parameters
box- reference on the box solid volume

◆ GGEMSBox() [3/3]

GGEMSBox::GGEMSBox ( GGEMSBox const &&  box)
delete

Avoid copy of the class by rvalue reference.

Parameters
box- rvalue reference on the box solid volume

Member Function Documentation

◆ Draw()

void GGEMSBox::Draw ( void  )
overridevirtual

Draw analytical volume in voxelized phantom.

Implements GGEMSVolume.

Definition at line 90 of file GGEMSBox.cc.

◆ Initialize()

void GGEMSBox::Initialize ( void  )
overridevirtual

Initialize the solid and store it in Phantom creator manager.

Implements GGEMSVolume.

Definition at line 67 of file GGEMSBox.cc.

◆ operator=() [1/2]

GGEMSBox & GGEMSBox::operator= ( GGEMSBox const &&  box)
delete

Avoid copy of the class by rvalue reference.

Parameters
box- rvalue reference on the box solid volume

◆ operator=() [2/2]

GGEMSBox & GGEMSBox::operator= ( GGEMSBox const &  box)
delete

Avoid assignement of the class by reference.

Parameters
box- reference on the box solid volume

Member Data Documentation

◆ depth_

GGfloat GGEMSBox::depth_
private

Depth of the box

Definition at line 100 of file GGEMSBox.hh.

◆ height_

GGfloat GGEMSBox::height_
private

Height of the box

Definition at line 98 of file GGEMSBox.hh.

◆ width_

GGfloat GGEMSBox::width_
private

Width of the box

Definition at line 99 of file GGEMSBox.hh.


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