application.h

Go to the documentation of this file.

/*
 * Copyright 2009-2020 The VOTCA Development Team (http://www.votca.org)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#ifndef VOTCA_TOOLS_APPLICATION_H
#define VOTCA_TOOLS_APPLICATION_H
 
// Third party includes
#include <boost/program_options.hpp>
 
// Local VOTCA includes
#include "property.h"
 
namespace votca {
namespace tools {
 
class Application {
 public:
  Application();
  virtual ~Application();
 
  int Exec(int argc, char **argv);
 
  virtual std::string ProgramName() = 0;
 
  virtual std::string VersionString() { return ""; }
 
  virtual void HelpText(std::ostream &out) = 0;
 
  virtual void Initialize() = 0;
 
  virtual bool EvaluateOptions() = 0;
 
  void CheckRequired(const std::string &option_name,
                     const std::string &error_msg = "");
 
  virtual void Run() = 0;
 
  boost::program_options::options_description_easy_init AddProgramOptions(
      const std::string &group = "");
 
  boost::program_options::variables_map &OptionsMap() { return op_vm_; }
  boost::program_options::options_description &OptionsDesc() {
    return op_desc_;
  }
 
  boost::program_options::options_description &VisibleOptions() {
    return visible_options_;
  }
 
  void StopExecution() { continue_execution_ = false; }
 
 protected:
  std::map<std::string, boost::program_options::options_description> op_groups_;
 
  virtual void ShowHelpText(std::ostream &out);
 
  bool continue_execution_ = true;
 
 private:
  boost::program_options::options_description op_desc_;
  boost::program_options::variables_map op_vm_;
  void ParseCommandLine(int argc, char **argv);
 
  boost::program_options::options_description visible_options_;
};
 
}  // namespace tools
}  // namespace votca
 
#endif  // VOTCA_TOOLS_APPLICATION_H