GGEMSNavigator.hh

Go to the documentation of this file.

#ifndef GUARD_GGEMS_NAVIGATORS_GGEMSNAVIGATOR_HH
#define GUARD_GGEMS_NAVIGATORS_GGEMSNAVIGATOR_HH
 
// ************************************************************************
// * This file is part of GGEMS.                                          *
// *                                                                      *
// * GGEMS is free software: you can redistribute it and/or modify        *
// * it under the terms of the GNU General Public License as published by *
// * the Free Software Foundation, either version 3 of the License, or    *
// * (at your option) any later version.                                  *
// *                                                                      *
// * GGEMS is distributed in the hope that it will be useful,             *
// * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
// * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
// * GNU General Public License for more details.                         *
// *                                                                      *
// * You should have received a copy of the GNU General Public License    *
// * along with GGEMS.  If not, see <https://www.gnu.org/licenses/>.      *
// *                                                                      *
// ************************************************************************
 
#ifdef _MSC_VER
#pragma warning(disable: 4251) // Deleting warning exporting STL members!!!
#endif
 
#define NAVIGATOR_NOT_INITIALIZED 0x100000000 
#include "GGEMS/physics/GGEMSRangeCuts.hh"
 
#include "GGEMS/geometries/GGEMSGeometryConstants.hh"
 
#include "GGEMS/maths/GGEMSMatrixTypes.hh"
 
class GGEMSSolid;
class GGEMSMaterials;
class GGEMSCrossSections;
class GGEMSDosimetryCalculator;
 
class GGEMS_EXPORT GGEMSNavigator
{
  public:
    explicit GGEMSNavigator(std::string const& navigator_name);
 
    virtual ~GGEMSNavigator(void);
 
    GGEMSNavigator(GGEMSNavigator const& navigator) = delete;
 
    GGEMSNavigator& operator=(GGEMSNavigator const& navigator) = delete;
 
    GGEMSNavigator(GGEMSNavigator const&& navigator) = delete;
 
    GGEMSNavigator& operator=(GGEMSNavigator const&& navigator) = delete;
 
    void SetPosition(GGfloat const& position_x, GGfloat const& position_y, GGfloat const& position_z, std::string const& unit = "mm");
 
    void SetRotation(GGfloat const& rx, GGfloat const& ry, GGfloat const& rz, std::string const& unit = "deg");
 
    void SetThreshold(GGfloat const& threshold, std::string const& unit = "keV");
 
    void SetNavigatorID(GGsize const& navigator_id);
 
    inline std::string GetNavigatorName(void) const {return navigator_name_;}
 
    inline GGsize GetNumberOfSolids(void) const {return number_of_solids_;}
 
    inline GGEMSSolid* GetSolids(GGsize const& solid_index) const {return solids_[solid_index];}
 
    inline GGEMSMaterials* GetMaterials(void) const {return materials_;}
 
    inline GGEMSCrossSections* GetCrossSections(void) const {return cross_sections_;}
 
    void ParticleSolidDistance(GGsize const& thread_index);
 
    void ProjectToSolid(GGsize const& thread_index);
 
    void TrackThroughSolid(GGsize const& thread_index);
 
    void PrintInfos(void) const;
 
    virtual void Initialize(void);
 
    virtual void SaveResults(void) = 0;
 
    void ComputeDose(GGsize const& thread_index);
 
    void StoreOutput(std::string basename);
 
    void SetDosimetryCalculator(GGEMSDosimetryCalculator* dosimetry_calculator);
 
    void EnableTracking(void);
 
  protected:
    virtual void CheckParameters(void) const;
 
  protected:
    std::string navigator_name_; 
    // Global navigation members
    GGfloat3 position_xyz_; 
    GGfloat3 rotation_xyz_; 
    GGsize navigator_id_; 
    bool is_update_pos_; 
    bool is_update_rot_; 
    GGfloat threshold_; 
    bool is_tracking_; 
    // Output
    std::string output_basename_; 
    GGEMSSolid** solids_; 
    GGsize number_of_solids_; 
    GGEMSMaterials* materials_; 
    GGEMSCrossSections* cross_sections_; 
    // Dosimetry
    GGEMSDosimetryCalculator* dose_calculator_; 
    bool is_dosimetry_mode_; 
    GGsize number_activated_devices_; 
};
 
#endif // End of GUARD_GGEMS_NAVIGATORS_GGEMSNAVIGATOR_HH