vEvent.hh

Go to the documentation of this file.

/*
This file is part of CASToR.

    CASToR 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.

    CASToR 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
    CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.

Copyright 2017-2019 all CASToR contributors listed below:

    --> Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Thibaut MERLIN, Mael MILLARDET, Simon STUTE, Valentin VIELZEUF

This is CASToR version 3.0.
*/

#ifndef VEVENT_HH
#define VEVENT_HH 1

#include "gVariables.hh"

class vEvent
{
  // -------------------------------------------------------------------
  // Constructor & Destructor
  public:
    vEvent();
    virtual ~vEvent();

  // -------------------------------------------------------------------
  // Public member functions
  public:
    int AllocateID();
    virtual int AllocateSpecificData() = 0;
    virtual void Describe() = 0;

  // -------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline uint32_t GetTimeInMs()
           {return m_timeInMs;}
    inline uint16_t GetNbLines()
           {return m_nbLines;};
    inline uint32_t GetID1(int a_line)
           {return mp_ID1[a_line];}
    inline uint32_t GetID2(int a_line)
           {return mp_ID2[a_line];}
    inline uint32_t* GetEventID1()
           {return mp_ID1;}
    inline uint32_t* GetEventID2()
           {return mp_ID2;}
    inline int GetDataType()
           {return m_dataType;}
    inline int GetDataMode()
           {return m_dataMode;}
    inline void SetTimeInMs(uint32_t a_value)
           {m_timeInMs = a_value;};
    virtual void SetEventValue(int a_bin, FLTNBDATA a_value) = 0; 
    inline void SetNbLines(uint16_t a_value)
           {m_nbLines = a_value;};
    inline void SetID1(int a_line, uint32_t a_value)
           {mp_ID1[a_line] = a_value;}
    inline void SetID2(int a_line, uint32_t a_value)
           {mp_ID2[a_line] = a_value;}
    inline void SetVerbose(int a_verbose)
           {m_verbose = a_verbose;}
    virtual FLTNB GetEventValue(int a_bin) = 0;
    virtual FLTNB GetAdditiveCorrections(int a_bin) = 0;
    inline virtual FLTNB GetBlankValue()
           {return 0.;}
    virtual FLTNB GetMultiplicativeCorrections() = 0;
    virtual INTNB GetNbValueBins() = 0;
    virtual void MultiplyAdditiveCorrections(FLTNB a_factor) = 0;

  // -------------------------------------------------------------------
  // Private member functions
  private:

  // -------------------------------------------------------------------
  // Data members
  protected:
    uint32_t m_timeInMs; 
    uint16_t m_nbLines;  
    uint32_t* mp_ID1;    
    uint32_t* mp_ID2;    
    FLTNB m_eventValue;  
    int m_dataType;      
    int m_dataMode;      
    int m_dataSpec;                           
    int m_verbose;       
};

#endif