Unpacker.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2002 -2011 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// dspsr/Kernel/Classes/dsp/Unpacker.h
 
 
#ifndef __Unpacker_h
#define __Unpacker_h
 
#include "dsp/Transformation.h"
#include "dsp/TimeSeries.h"
#include "dsp/BitSeries.h"
#include "dsp/Input.h"
 
#include "Registry.h"
 
namespace dsp {
 
 
  class Unpacker : public Transformation <BitSeries, TimeSeries>
  {
 
  public:
    
    Unpacker (const char* name = "Unpacker");
 
    virtual Unpacker* clone() const;
    
    static Unpacker* create (const Observation* observation);
 
    virtual bool get_order_supported (TimeSeries::Order) const;
 
    virtual void set_output_order (TimeSeries::Order);
 
    virtual bool get_device_supported (Memory*) const;
 
    virtual void set_device (Memory*);
 
 
    virtual bool matches (const Observation* observation) = 0;
 
    virtual void match_resolution (Input*) {}
 
    virtual unsigned get_resolution () const { return 0; }
 
    void prepare ();
 
    void reserve ();
 
    class Iterator;
 
    Iterator get_iterator (unsigned idig);
 
    typedef Registry::List<Unpacker> Register;
 
   protected:
 
    TimeSeries::Order output_order;
 
    virtual void transformation ();
    
 
    virtual void unpack () = 0;
 
    virtual void match (const Observation* observation);
 
    static Register& get_register();
 
    template<class T>
    const T* get_Input ()
    {
      const Input* input = NULL;
 
      if (get_input()) 
        if (get_input()->get_loader()) 
          input = get_input()->get_loader()->get_origin();
 
      if (!input)
        throw Error (InvalidState, "Unpacker::get_Input",
            "Input object does not exist");
 
      const T* ptr = dynamic_cast<const T*>( input );
      if( ptr )
        return ptr;
 
      throw Error (InvalidState, "Unpacker::get_Input",
                   "BitSeries::input is not of required type");
    }
  };
 
}
 
#endif // !defined(__Unpacker_h)