/* This file is part of MAUS: http://micewww.pp.rl.ac.uk/projects/maus
 *
 * MAUS 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.
 *
 * MAUS 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 MAUS.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _SRC_COMMON_CPP_DATASTRUCTURE_V1731_
#define _SRC_COMMON_CPP_DATASTRUCTURE_V1731_

#include <vector>
#include <string>

#include "Utils/VersionNumber.hh"

namespace MAUS {
// Needed for ROOT
typedef std::vector<int> SampleArray;

/** @class V1731 comment
 *
 *  @var ldc_id  <--description-->
 *  @var samples  <--description-->
 *  @var charge_mm  <--description-->
 *  @var equip_type  <--description-->
 *  @var phys_event_number  <--description-->
 *  @var charge_pm  <--description-->
 *  @var arrival_time  <--description-->
 *  @var channel_key  <--description-->
 *  @var position_min  <--description-->
 *  @var pulse_area  <--description-->
 *  @var max_pos  <--description-->
 *  @var trigger_time_tag  <--description-->
 *  @var time_stamp  <--description-->
 *  @var detector  <--description-->
 *  @var part_event_number  <--description-->
 *  @var geo  <--description-->
 *  @var pedestal  <--description-->
 *  @var channel  <--description-->
 */

class V1731 {
  public:
    /** Default constructor - initialises to 0/NULL */
    V1731();

    /** Copy constructor - any pointers are deep copied */
    V1731(const V1731& _v1731);

    /** Equality operator - any pointers are deep copied */
    V1731& operator=(const V1731& _v1731);

    /** Destructor - any member pointers are deleted */
    virtual ~V1731();


    /** Returns LdcId */
    int GetLdcId() const;

    /** Sets LdcId */
    void SetLdcId(int ldc_id);

    /** Returns SampleArray */
    SampleArray GetSampleArray() const;

    /** Get an element from SampleArray (needed for PyROOT) */
    int GetSampleArrayElement(size_t index) const;

    /** Get size of SampleArray (needed for PyROOT) */
    size_t GetSampleArraySize() const;

    /** Sets SampleArray */
    void SetSampleArray(SampleArray samples);

    /** Returns ChargeMm */
    int GetChargeMm() const;

    /** Sets ChargeMm */
    void SetChargeMm(int charge_mm);

    /** Returns EquipType */
    int GetEquipType() const;

    /** Sets EquipType */
    void SetEquipType(int equip_type);

    /** Returns PhysEventNumber */
    int GetPhysEventNumber() const;

    /** Sets PhysEventNumber */
    void SetPhysEventNumber(int phys_event_number);

    /** Returns ChargePm */
    int GetChargePm() const;

    /** Sets ChargePm */
    void SetChargePm(int charge_pm);

    /** Returns ArrivalTime */
    int GetArrivalTime() const;

    /** Sets ArrivalTime */
    void SetArrivalTime(int arrival_time);

    /** Returns ChannelKey */
    std::string GetChannelKey() const;

    /** Sets ChannelKey */
    void SetChannelKey(std::string channel_key);

    /** Returns PositionMin */
    int GetPositionMin() const;

    /** Sets PositionMin */
    void SetPositionMin(int position_min);

    /** Returns PulseArea */
    int GetPulseArea() const;

    /** Sets PulseArea */
    void SetPulseArea(int pulse_area);

    /** Returns MaxPos */
    int GetPositionMax() const;

    /** Sets MaxPos */
    void SetPositionMax(int max_pos);

    /** Returns TriggerTimeTag */
    int GetTriggerTimeTag() const;

    /** Sets TriggerTimeTag */
    void SetTriggerTimeTag(int trigger_time_tag);

    /** Returns TimeStamp */
    int GetTimeStamp() const;

    /** Sets TimeStamp */
    void SetTimeStamp(int time_stamp);

    /** Returns Detector */
    std::string GetDetector() const;

    /** Sets Detector */
    void SetDetector(std::string detector);

    /** Returns PartEventNumber */
    int GetPartEventNumber() const;

    /** Sets PartEventNumber */
    void SetPartEventNumber(int part_event_number);

    /** Returns Geo */
    int GetGeo() const;

    /** Sets Geo */
    void SetGeo(int geo);

    /** Returns Pedestal */
    double GetPedestal() const;

    /** Sets Pedestal */
    void SetPedestal(double pedestal);

    /** Returns Channel */
    int GetChannel() const;

    /** Sets Channel */
    void SetChannel(int channel);

  private:
    int _ldc_id;
    SampleArray _samples;
    int _charge_mm;
    int _equip_type;
    int _phys_event_number;
    int _charge_pm;
    int _arrival_time;
    std::string _channel_key;
    int _position_min;
    int _pulse_area;
    int _position_max;
    int _trigger_time_tag;
    int _time_stamp;
    std::string _detector;
    int _part_event_number;
    int _geo;
    double _pedestal;
    int _channel;

    MAUS_VERSIONED_CLASS_DEF(V1731)
};
}

#endif  // _SRC_COMMON_CPP_DATASTRUCTURE_V1731_