RtclCmdBase.hpp

Go to the documentation of this file.

// $Id: RtclCmdBase.hpp 1186 2019-07-12 17:49:59Z mueller $
// SPDX-License-Identifier: GPL-3.0-or-later
// Copyright 2013-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
// 
// Revision History: 
// Date         Rev Version  Comment
// 2018-12-16  1084   1.1.4  use =delete for noncopyable instead of boost
// 2018-12-15  1083   1.1.3  AddMeth(): use rval ref and move semantics
// 2018-12-14  1081   1.1.2  use std::function instead of boost
// 2017-04-02   865   1.1.1  add GetArgsDump()
// 2017-04-02   863   1.1    add DelMeth(),TstMeth(); add M_info() and '?'
//                           rename fMapMeth -> fMethMap
// 2013-04-26   511   1.0.1  AddMeth() now public
// 2013-02-02   480   1.0    Initial version (refactored out from ProxyBase)
// ---------------------------------------------------------------------------
 
#ifndef included_Retro_RtclCmdBase
#define included_Retro_RtclCmdBase 1
 
#include "tcl.h"
 
#include <string>
#include <map>
#include <functional>
 
#include "RtclArgs.hpp"
 
namespace Retro {
 
  class RtclCmdBase {
    public:
      typedef std::function<int(RtclArgs&)> methfo_t;
 
      typedef std::map<std::string, methfo_t> mmap_t;
      typedef mmap_t::iterator         mmap_it_t;
      typedef mmap_t::const_iterator   mmap_cit_t;
 
                    RtclCmdBase();
      virtual      ~RtclCmdBase();
 
                    RtclCmdBase(const RtclCmdBase&) = delete;   // noncopyable 
      RtclCmdBase&  operator=(const RtclCmdBase&) = delete;     // noncopyable
 
      int           DispatchCmd(RtclArgs& args);
      void          AddMeth(const std::string& name, methfo_t&& methfo);
      void          DelMeth(const std::string& name);
      bool          TstMeth(const std::string& name);
        
    // some constants (also defined in cpp)
      static const int kOK  = TCL_OK;       
      static const int kERR = TCL_ERROR;    
 
    protected:
      bool          GetArgsDump(RtclArgs& args, int& detail);
      int           M_info(RtclArgs& args);
 
    protected:
      mmap_t        fMethMap;               
  };
  
} // end namespace Retro
 
//#include "RtclCmdBase.ipp"
 
#endif