emcCalibrationData.h

Go to the documentation of this file.

#ifndef __EMCCALIBRATIONDATA_H__
#define __EMCCALIBRATIONDATA_H__

#ifndef __EMCMANAGEABLE_H__
#include "emcManageable.h"
#endif
#ifndef __PHTIMESTAMP_H__
#include "PHTimeStamp.h"
#endif

class emcCalibrationData : public emcManageable
  {

  public:

    // If you add a new enum there, put it AFTER those ones !
    enum EType { kUnknown = 0, 
                 kIniCal=1,         
 // 2,3,4 are not used on purpose (used to be there and were removed) 
                 kTofSectorOffset=5 
               };

    emcCalibrationData(EType type = kUnknown, size_t number = 0, size_t size = 0);
    virtual ~emcCalibrationData();

    // The category is used to build the database filename.
    const char* GetCategory(void) const;

    // End-of-validity time.
    const PHTimeStamp& GetEndValTime(void) const
      {
        return fEnd;
      }

    // Get the dimension of the internal arrays.
    size_t GetDimension(void) const
      {
        return fDimension;
      }

    // Get dim-th error for a given "channel".
    float GetError(size_t index, size_t dim = 0) const;

    // Get the characteristic number of this object.
    size_t GetNumber(void) const
      {
        return fNumber;
      }

    // Get the maximum allowed number of this object.
    size_t GetRange(void) const
      {
        return fRange;
      }

    // Get the size (i.e. the number of "channels").
    size_t GetSize(void) const
      {
        return fSize;
      }

    // Start-of-validity time.
    const PHTimeStamp& GetStartValTime(void) const
      {
        return fStart;
      }

    // Get the type of this object.
    EType GetType(void) const
      {
        return fType;
      }

    // Convert the type into a string. (static version)
    static const char* GetTypeName(EType type);

    // Convert the type into a string.
    const char* GetTypeName(void) const
      {
        return GetTypeName(fType);
      }

    // Get the dim-th value of a given "channel", indexed by index.
    float GetValue(size_t index, size_t dim = 0) const;

    // Tells if the object is valid at time 'when'
    virtual bool IsValid(const PHTimeStamp& when) const;

    // Prints header (level=0) or full object (level>0).
    void Print(int level = 0) const;

    // Resets completely the object (erases internal arrays).
    virtual void Reset(void);

    // Set value and error for a given dimension of a given channel.
    bool Set(size_t index, float value, float error, size_t dim = 0);

    void SetTypeAndSize(EType type, size_t size);

    // Set the characteristic number of this object.
    void SetNumber(size_t number)
    {
      fNumber = number;
    }

    // Set the validity period.
    void SetValidityPeriod(const PHTimeStamp& t1, const PHTimeStamp& t2)
    {
      fStart = t1;
      fEnd = t2;
    }

  public:
    static const float fgInvalidFloat;

  private:
    PHTimeStamp fStart;
    PHTimeStamp fEnd;
    EType fType;
    size_t fNumber;
    float** fValues;
    float** fErrors;
    size_t fSize;
    size_t fDimension;
    size_t fRange;
  };

#endif