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

GGEMS class managing the range cuts in GGEMS simulation. More...

#include "GGEMSRangeCutsManager.hh"

Collaboration diagram for GGEMSRangeCutsManager:
Collaboration graph

Public Member Functions

 GGEMSRangeCutsManager (GGEMSRangeCutsManager const &range_cuts_manager)=delete
 Avoid copy of the class by reference. More...
 
GGEMSRangeCutsManageroperator= (GGEMSRangeCutsManager const &range_cuts_manager)=delete
 Avoid assignement of the class by reference. More...
 
 GGEMSRangeCutsManager (GGEMSRangeCutsManager const &&range_cuts_manager)=delete
 Avoid copy of the class by rvalue reference. More...
 
GGEMSRangeCutsManageroperator= (GGEMSRangeCutsManager const &&range_cuts_manager)=delete
 Avoid copy of the class by rvalue reference. More...
 
void SetLengthCut (std::string const &phantom_name, std::string const &particle_name, GGfloat const &value, std::string const &unit="mm")
 set the range cut length for a phantom and a particle More...
 
void PrintInfos (void) const
 print infos about range cut manager More...
 
void Clean (void)
 clean OpenCL data if necessary More...
 

Static Public Member Functions

static GGEMSRangeCutsManagerGetInstance (void)
 Create at first time the Singleton. More...
 

Private Member Functions

 GGEMSRangeCutsManager (void)
 Unable the constructor for the user. More...
 
 ~GGEMSRangeCutsManager (void)
 Unable the destructor for the user. More...
 

Detailed Description

GGEMS class managing the range cuts in GGEMS simulation.

Definition at line 46 of file GGEMSRangeCutsManager.hh.

Constructor & Destructor Documentation

◆ GGEMSRangeCutsManager() [1/3]

GGEMSRangeCutsManager::GGEMSRangeCutsManager ( void  )
private

Unable the constructor for the user.

Definition at line 39 of file GGEMSRangeCutsManager.cc.

◆ ~GGEMSRangeCutsManager()

GGEMSRangeCutsManager::~GGEMSRangeCutsManager ( void  )
private

Unable the destructor for the user.

Definition at line 50 of file GGEMSRangeCutsManager.cc.

◆ GGEMSRangeCutsManager() [2/3]

GGEMSRangeCutsManager::GGEMSRangeCutsManager ( GGEMSRangeCutsManager const &  range_cuts_manager)
delete

Avoid copy of the class by reference.

Parameters
range_cuts_manager- reference on the range cuts manager

◆ GGEMSRangeCutsManager() [3/3]

GGEMSRangeCutsManager::GGEMSRangeCutsManager ( GGEMSRangeCutsManager const &&  range_cuts_manager)
delete

Avoid copy of the class by rvalue reference.

Parameters
range_cuts_manager- rvalue reference on the range cuts manager

Member Function Documentation

◆ Clean()

void GGEMSRangeCutsManager::Clean ( void  )

clean OpenCL data if necessary

Definition at line 61 of file GGEMSRangeCutsManager.cc.

◆ GetInstance()

static GGEMSRangeCutsManager & GGEMSRangeCutsManager::GetInstance ( void  )
inlinestatic

Create at first time the Singleton.

Returns
Object of type GGEMSRangeCutsManager

Definition at line 65 of file GGEMSRangeCutsManager.hh.

◆ operator=() [1/2]

GGEMSRangeCutsManager & GGEMSRangeCutsManager::operator= ( GGEMSRangeCutsManager const &&  range_cuts_manager)
delete

Avoid copy of the class by rvalue reference.

Parameters
range_cuts_manager- rvalue reference on the range cuts manager

◆ operator=() [2/2]

GGEMSRangeCutsManager & GGEMSRangeCutsManager::operator= ( GGEMSRangeCutsManager const &  range_cuts_manager)
delete

Avoid assignement of the class by reference.

Parameters
range_cuts_manager- reference on the range cuts manager

◆ PrintInfos()

void GGEMSRangeCutsManager::PrintInfos ( void  ) const

print infos about range cut manager

Definition at line 72 of file GGEMSRangeCutsManager.cc.

◆ SetLengthCut()

void GGEMSRangeCutsManager::SetLengthCut ( std::string const &  phantom_name,
std::string const &  particle_name,
GGfloat const &  value,
std::string const &  unit = "mm" 
)

set the range cut length for a phantom and a particle

Parameters
phantom_name- name of the phantom
particle_name- name of the particle
value- value of the cut
unit- unit of the cut in length

Definition at line 115 of file GGEMSRangeCutsManager.cc.


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