step.h

/***************************************************************************
                          step.h  -  description
                             -------------------
    begin                : Sat Dec 30 2006
    copyright            : (C) 2001 by Thies Jochimsen
    email                : jochimse@cns.mpg.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef RECOSTEP_H
#define RECOSTEP_H

#include <odindata/step.h>

#include <odinreco/odinreco.h>
#include <odinreco/index.h>

class RecoData; // forward declaration
class RecoController; // forward declaration


struct RecoQueryContext {


  enum queryMode {prep=0, finalize, print};
  queryMode mode;

  RecoController& controller;

  STD_string printprefix;

  STD_string printpostfix;

  RecoCoord coord;

  RecoQueryContext(queryMode m, RecoController& contr, unsigned short numof[n_recoDims]) : mode(m), controller(contr) {
    for(int idim=0; idim<n_recoDims; idim++) coord.index[idim].set_numof(numof[idim]); // initializing numof in this branch
  }

};



class RecoStep : public Step<RecoStep> {

 public:

  virtual ~RecoStep() {}

  virtual bool process(RecoData& rd, RecoController& controller) = 0;


  virtual RecoCoord input_coord() const = 0;

  virtual void modify_coord(RecoCoord& coord) const = 0;


  virtual bool pipeline_init(const RecoController& controller, const RecoCoord& input_coord) {return true;}


  virtual bool query(RecoQueryContext& context);


  void set_next_step(RecoStep* step) {next_step=step;}



  // To be used by factory via duck typing
  static void create_templates(STD_list<RecoStep*>& result);
  static STD_string manual_group() {return "odinreco_steps";}
  static void interface_description(const RecoStep* step, STD_string& in, STD_string& out);



 protected:
  friend class RecoController;

  RecoStep() : next_step(0) {}



  bool execute_next_step(RecoData& rd, RecoController& controller);


 private:

  void interface_dims(int& in, int& out) const;


  RecoStep* next_step;

};





typedef StepFactory<RecoStep> RecoStepFactory; // The factory for reco steps



#endif