EGSnrc C++ class library  Report PIRS-898 (2021)
Iwan Kawrakow, Ernesto Mainegra-Hing, Frederic Tessier, Reid Townson and Blake Walters
Public Member Functions | Protected Attributes | List of all members
BEAM_DoseScoring Class Reference

A dose scoring object: header. More...

#include <beam_dose_scoring.h>

Inheritance diagram for BEAM_DoseScoring:
EGS_AusgabObject EGS_Object

Public Member Functions

 BEAM_DoseScoring (const string &Name="", EGS_ObjectFactory *f=0)
 
int processEvent (EGS_Application::AusgabCall iarg)
 
bool needsCall (EGS_Application::AusgabCall iarg) const
 
void setApplication (EGS_Application *App)
 
void reportResults ()
 
void setCurrentCase (EGS_I64 ncase)
 
int getDigits (int i)
 
void setVol (const vector< EGS_Float > volin)
 
void setVol (const EGS_Float volin)
 
void setDoseCMs (const vector< int > dcm)
 
void setMediumScoring (bool flag)
 
void setRegionScoring (bool flag)
 
bool storeState (ostream &data) const
 
bool setState (istream &data)
 
void resetCounter ()
 
bool addState (istream &data)
 
int addTheStates (istream &data)
 
- Public Member Functions inherited from EGS_AusgabObject
 EGS_AusgabObject (const string &Name="", EGS_ObjectFactory *f=0)
 Construct an ausgab object named Name.
 
 EGS_AusgabObject (EGS_Input *input, EGS_ObjectFactory *f=0)
 Construct an ausgab object from the input pointed to by inp. More...
 
virtual int processEvent (EGS_Application::AusgabCall iarg, int ir)
 
const char * getObjectDescription () const
 Get a short description of this ausgab object. More...
 
- Public Member Functions inherited from EGS_Object
 EGS_Object (const string &Name="", EGS_ObjectFactory *f=0)
 Create an EGS_Object named Name belonging to the object factory f. More...
 
 EGS_Object (EGS_Input *inp, EGS_ObjectFactory *f=0)
 Create an EGS_Object from the information pointed to by inp that belongs to object factory f. More...
 
const string & getObjectName () const
 Get the object name.
 
void setObjectName (const string &Name)
 Set the object name to Name.
 
const string & getObjectType () const
 Get the object type.
 
virtual EGS_ObjectcreateObject (EGS_Input *inp)
 Create an object from the infromation pointed to by inp. More...
 
void setName (EGS_Input *inp)
 Set the name of the object from the information provided by inp. More...
 
int ref ()
 Increase the reference count to this object.
 
int deref ()
 Decrease the reference count to this object.
 
void setFactory (EGS_ObjectFactory *f)
 Set the factory to which the object belongs. More...
 

Protected Attributes

BEAMpp_Application * bapp
 
EGS_ScoringArraydose
 Scoring in each dose scoring region.
 
EGS_ScoringArraydoseM
 Scoring dose in each medium.
 
vector< EGS_Float > vol_list
 
vector< int > d_cms
 
vector< int > d_region
 
vector< int > d_reg_index
 
vector< int > d_reg_cm_ind
 
vector< vector< int > > cm_med
 
vector< EGS_Float > vol
 
int nreg
 
int nmedia
 
int max_dreg
 
int max_medl
 
EGS_I64 m_lastCase
 The event set via setCurrentCase()
 
bool score_medium_dose
 
bool score_region_dose
 
- Protected Attributes inherited from EGS_AusgabObject
string description
 A short ausgab object description. More...
 
EGS_Applicationapp
 The application this object belongs to.
 
- Protected Attributes inherited from EGS_Object
string name
 The object name.
 
string otype
 The object type.
 
int nref
 Number of references to the object.
 
EGS_ObjectFactoryfactory
 The factory this object belongs to.
 

Additional Inherited Members

- Static Public Member Functions inherited from EGS_AusgabObject
static void createAusgabObjects (EGS_Input *)
 Create ausgab objects from the information pointed to by input. More...
 
static EGS_AusgabObjectgetAusgabObject (const string &Name)
 Get a pointer to the ausgab object named Name. More...
 
static void addKnownAusgabObject (EGS_AusgabObject *o)
 Add a known ausgab object to the ausgab object factory. More...
 
static void addKnownTypeId (const char *name)
 Add a known ausgab object typeid to the ausgab object factory. More...
 
static int nObjects ()
 Returns the number of ausgab objects in the internal list.
 
static EGS_AusgabObjectgetObject (int j)
 Returns the j'th ausgab object in the internal list.
 
- Static Public Member Functions inherited from EGS_Object
static string getUniqueName (const EGS_Object *o=0)
 Create and return a unique object name. More...
 
static void deleteObject (EGS_Object *o)
 Delete an object. More...
 

Detailed Description

A dose scoring object: header.

An ausgab object for BEAMpp which can be used to calculate dose to regions or dose to media within user-specified CMs. It is identical to the EGS_DoseScoring class with some minor modifications.

Definition at line 85 of file beam_dose_scoring.h.


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