odindata/step.h

/***************************************************************************
                          step.h  -  description
                             -------------------
    begin                : Sat Dec 30 2006
    copyright            : (C) 2000-2021 by Thies Jochimsen
    email                : thies@jochimsen.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 STEP_H
#define STEP_H
 
#include <odindata/data.h>
 
 
template<class T>
class Step {
 
 public:
 
  virtual ~Step() {}
 
  virtual STD_string label() const = 0;
 
  virtual STD_string description() const = 0;
 
  virtual T* allocate() const = 0;
 
  virtual void init() = 0;
 
  T* clone() const;
 
  void set_args(const STD_string& argstr);
 
 
  STD_string args_description() const;
 
  STD_string args_values() const;
 
  unsigned int numof_args() const {return args.numof_pars();}
 
 
  void append_opts(LDRblock& parblock);
 
 
 protected:
 
 
  void append_arg(LDRbase& arg, const STD_string& arglabel);
 
 
  const char* c_label() const {if(!label_cache.size()) label_cache=label(); return label_cache.c_str();} // For Debug
 
 private:
 
  LDRblock args;
  mutable STD_string label_cache;
};
 
 
 
template<class T>
class StepFactory {
 
 public:
 
  StepFactory(LDRblock* parblock=0);
 
  ~StepFactory();
 
  T* create(const STD_string& label) const;
 
  STD_string manual() const;
 
  STD_string get_cmdline_usage(const STD_string& lineprefix) const;
 
 private:
 
  typedef STD_map<STD_string,T*> StepMap;
  StepMap templates;
 
  mutable STD_list<T*> garbage;
 
};
 
 
#endif