Operation.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2002 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// dspsr/Kernel/Classes/dsp/Operation.h
 
#ifndef __Operation_h
#define __Operation_h
 
#include "dsp/dsp.h"
 
#include "RealTimer.h"
#include "OwnStream.h"
#include "environ.h"
 
#include <string>
#include <vector>
 
namespace dsp {
 
  class Scratch;
  class Extensions;
 
 
  class Operation : public OwnStream {
 
  public:
 
    static bool record_time;
 
    static bool report_time;
 
    static bool verbose;
 
    static int operation_status;
 
    static bool check_state;
 
    static int instantiation_count;
 
    Operation (const char* name);
 
    Operation (const Operation&);
 
    virtual ~Operation ();
 
    virtual bool operate ();
 
 
    virtual void prepare ();
 
 
    virtual void reserve ();
 
    virtual void add_extensions (Extensions*);
 
 
    virtual void combine (const Operation*);
 
    virtual void report () const;
 
    virtual void reset ();
 
    std::string get_name() const { return name; }
 
    double get_total_time () const;
 
    double get_elapsed_time() const;
 
    virtual uint64_t get_total_weights () const;
 
    virtual uint64_t get_discarded_weights () const;
 
    int get_id() { return id; }
 
    enum Function
    {
      Producer,      
      Procedural,    
      Structural     
    };
 
    virtual Function get_function () const { return Procedural; }
 
    virtual double get_delay_time () const { return 0.0; }
 
    virtual void set_scratch (Scratch*);
    bool scratch_was_set () const;
 
    virtual uint64_t bytes_storage() const { return 0; }
 
 
    virtual uint64_t bytes_scratch () const { return 0; }
 
  protected:
 
    Scratch* scratch;
    bool set_scratch_called;
 
    virtual bool can_operate();
 
    virtual void operation () = 0;
 
    virtual void set_name (const std::string& _name){ name = _name; }
 
    std::string name;
 
    uint64_t discarded_weights;
 
    uint64_t total_weights;
 
    int timers_index (const std::string& op_name);
 
    RealTimer optime;
 
    int id;
 
    bool prepared;
 
  };
 
}
 
#endif