DataFrame.h

Go to the documentation of this file.

#ifndef SZA_UTIL_DATAFRAME_H
#define SZA_UTIL_DATAFRAME_H

#include "carma/szautil/AxisRange.h"
#include "carma/szautil/Complex.h"
#include "carma/szautil/RegDate.h"
#include "carma/szautil/DataType.h"
#include "carma/szautil/Mutex.h"

namespace sza {
  namespace util {
    
    class AxisRange;

    class DataFrame { 
    public:
      
      DataFrame();
      
      virtual ~DataFrame();
      
      virtual void resize(unsigned int nBuffer);
      
      virtual unsigned int size() = 0;
      
      unsigned int nReg();
      
      unsigned int nByte();
      
      virtual unsigned char& operator[](unsigned int index);
      
      virtual void operator=(DataFrame& frame);
      
      virtual unsigned char* data() = 0;
      virtual std::vector<unsigned char>& dataVec() = 0;

      void pack(void* data, AxisRange& range, DataType::Type type,
                unsigned iStart, bool lockFrame=true);
      
      void pack(void* data, unsigned ndata, DataType::Type type,
                unsigned iStart, bool lockFrame=true);
      
      void packValue(void* data, AxisRange& range, DataType::Type type,
                     unsigned iStart, bool lockFrame=true);
      
      void packValue(void* data, unsigned ndata, DataType::Type type,
                     unsigned iStart, bool lockFrame=true);
      
      void addSum(void* data, AxisRange& range, DataType::Type type,
                  unsigned iStart, bool lockFrame=true);
      
      void addSum(void* data, unsigned ndata, DataType::Type type,
                  unsigned iStart, bool lockFrame=true);
      
      void addRunningAverage(void* data, AxisRange& range, DataType::Type type,
                             unsigned iStart, bool lockFrame=true);
      
      void addRunningAverage(void* data, unsigned ndata, DataType::Type type,
                             unsigned iStart, bool lockFrame=true);
      
      void resetRunningAvgCounter();
      void incrementRunningAvgCounter();

      void addUnion(void* data, AxisRange& range, DataType::Type type,
                    unsigned iStart, bool lockFrame=true);
      
      void addUnion(void* data, unsigned ndata, DataType::Type type,
                    unsigned iStart, bool lockFrame=true);
      
      void unpack(void* data, AxisRange& range, DataType::Type type,
                  unsigned iStart, bool lockFrame=true);

      void unpack(void* data, unsigned ndata, DataType::Type type,
                  unsigned iStart, bool lockFrame=true);

      void* getPtr(unsigned int index, DataType::Type type);
      
      // Methods for returning pointers of different types to internal
      // data.  These are made virtual so that inheritors can define
      // what, if anything, happens when they are called.  For certain
      // types of frames, it may be inappropriate to recast pointers
      // to internal data, in which case some of the following should
      // throw exceptions.

      virtual bool* getBoolPtr(unsigned int index=0);
      
      virtual unsigned char* getUcharPtr(unsigned int index=0);
      
      virtual char* getCharPtr(unsigned int index=0);
      
      virtual unsigned short* getUshortPtr(unsigned int index=0);
      
      virtual short* getShortPtr(unsigned int index=0);
      
      virtual unsigned int* getUintPtr(unsigned int index=0);
      
      virtual int* getIntPtr(unsigned int index=0);
      
      virtual unsigned long* getUlongPtr(unsigned long index=0);
      
      virtual long* getLongPtr(unsigned long index=0);
      
      virtual float* getFloatPtr(unsigned int index=0);
      
      virtual double* getDoublePtr(unsigned int index=0);

      virtual RegDate::Data* getDatePtr(unsigned int index=0);

      virtual Complex<float>::Data* getComplexFloatPtr(unsigned int index=0);

      void lock();

      void unlock();

    public:

      // A counter for running averages

      unsigned nAvg_;

    private:

      Mutex guard_;

      AxisRange axisRange_;

    }; // End class DataFrame
    
  } // End namespace util
} // End namespace sza



#endif // End #ifndef SZA_UTIL_DATAFRAME_H