/Users/marc/Developer/EGSnrc/HEN_HOUSE/user_codes/egs_brachy/egs_brachy/latch.h

Go to the documentation of this file.

/*
################################################################################
#
#  egs_brachy latch.h
#  Copyright (C) 2016 Rowan Thomson, Dave Rogers, Randle Taylor, and Marc
#  Chamberland
#
#  This file is part of egs_brachy
#
#  egs_brachy is free software: you can redistribute it and/or modify it
#  under the terms of the GNU Affero General Public License as published
#  by the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  egs_brachy 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
#  Affero General Public License for more details:
#  <http://www.gnu.org/licenses/>.
#
################################################################################
#
#  When egs_brachy is used for publications, please cite our paper:
#  M. J. P. Chamberland, R. E. P. Taylor, D. W. O. Rogers, and R. M. Thomson,
#  egs brachy: a versatile and fast Monte Carlo code for brachytherapy,
#  Phys. Med. Biol. 61, 8214-8231 (2016).
#
################################################################################
#
#  Author:        Randle Taylor, 2016
#
#  Contributors:  Marc Chamberland
#                 Dave Rogers
#                 Rowan Thomson
#
################################################################################
*/
 
#ifndef EGS_BRACHY_LATCH
#define EGS_BRACHY_LATCH
#include "egs_advanced_application.h"
#include "pubsub.h"
 
class Latch : public Subscriber {
 
    enum Flag {
        IN_SOURCE, 
        ESCAPED_SOURCE, 
        PRIM_PARTICLE,
        SSCAT_PARTICLE,
        MSCAT_PARTICLE
 
    };
 
 
 
 
public:
 
    void update(EB_Message message, void *particle);
 
    //bool inSource(EGS_Particle *p);
 
    static bool hasEscaped(EGS_Particle *p);
 
    static void setFlag(Flag flag, EGS_Particle *p);
 
    static void setFlag(Flag flag, int &latch);
 
    static void unsetFlag(Flag flag, EGS_Particle *p);
 
    static void unsetFlag(Flag flag, int &latch);
 
    static bool checkFlag(Flag flag, EGS_Particle *p);
 
    static bool checkFlag(Flag flag, int latch);
 
    /* \brief add scattering event to particle latch */
    static void addScatter(EGS_Particle *p);
 
    /* \brief add scattering event to latch */
    static void addScatter(int &latch);
 
    /* \brief set primary flag for latch */
    static void setPrimary(int &latch);
 
    /* \brief set primary flag for particle*/
    static void setPrimary(EGS_Particle *p);
 
    /* \brief check if unscattered */
    static bool isPrimary(int latch);
    static bool isPrimary(EGS_Particle *p);
 
    /* \brief check if single scattered*/
    static bool isSingleScat(int latch);
    static bool isSingleScat(EGS_Particle *p);
 
    /* \brief check if multiple scattered*/
    static bool isMultScat(int latch);
    static bool isMultScat(EGS_Particle *p);
 
};
 
#endif