Pulse.h

Go to the documentation of this file.

 
/*
 *  JEMRIS Copyright (C) 
 *                        2006-2025  Tony Stoecker
 *                        2007-2018  Kaveh Vahedipour
 *                        2009-2019  Daniel Pflugfelder
 *                                  
 *
 *  This program 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef PULSE_H_
#define PULSE_H_
 
#include "Module.h"
#include "Parameters.h"
#include "TxRxPhase.h"
#include "Event.h"
 
class AtomicSequence;
class AnalyticPulseShape;
class ExternalPulseData;
 
 
class Pulse :public Module, public TxRxPhase {
 
 friend class AnalyticPulseShape;
 friend class ExternalPulseData;
 
 public:
 
    Pulse ();
 
    virtual ~Pulse         () {};
 
    Pulse                  (const Pulse&) :
        m_adc(0), m_initial_delay(0), m_axis(AXIS_VOID), m_adc_flag(1) {};
 
    virtual void GetValue  (double * dAllVal, double const time) const {};
 
    virtual bool Prepare   (const PrepareMode mode) ;
 
    void SetDuration       (double val) ;
 
    double          GetDuration    () { Notify(m_duration); return m_duration; };
 
    inline void SetAxis           (const PulseAxis eAxis)  { m_axis = eAxis; };
 
    inline PulseAxis GetAxis      ()   const              { return m_axis; };
 
 
    virtual void  SetTPOIs ();
 
    virtual void  GenerateEvents (std::vector<Event*> &events) {};
 
    inline  int  GetNADC  () { return m_adc * (m_adc_flag>0?1:0) ;  };
 
 
    inline void  SetNADC  (int nadc) {m_adc = abs(nadc); m_adc_flag = ( nadc<0 ? 0 : m_adc_flag );  SetTPOIs();};
 
    inline  int  GetADCFlag  () { return m_adc_flag;  };
 
    inline void  SetADCFlag  (int adcflag) {m_adc_flag = adcflag; SetTPOIs();};
 
    inline double  GetInitialDelay          () {return m_initial_delay; };
 
 protected:
 
    virtual string          GetInfo        ();
 
    PulseAxis     m_axis;              
    int           m_adc;               
    int                    m_adc_flag;          
    double        m_initial_delay;     
};
 
#endif