lammps/lib/colvars/colvarscript.h

53 lines
1.1 KiB
C++

/// -*- c++ -*-
#ifndef COLVARSCRIPT_H
#define COLVARSCRIPT_H
#include <string>
#include "colvarmodule.h"
#include "colvarvalue.h"
#include "colvarbias.h"
#include "colvarproxy.h"
// Only these error values are part of the scripting interface
#define COLVARSCRIPT_ERROR -1
#define COLVARSCRIPT_OK 0
class colvarscript {
private:
colvarproxy *proxy;
colvarmodule *colvars;
inline colvarscript() {} // no-argument construction forbidden
public:
friend class colvarproxy;
colvarscript(colvarproxy * p);
inline ~colvarscript() {}
/// If an error is caught by the proxy through fatal_error(), this is set to COLVARSCRIPT_ERROR
int proxy_error;
/// If an error is returned by one of the methods, it should set this to the error message
std::string result;
/// Run script command with given positional arguments
int run(int argc, char const *argv[]);
private:
/// Run subcommands on colvar
int proc_colvar(int argc, char const *argv[]);
/// Run subcommands on bias
int proc_bias(int argc, char const *argv[]);
/// Builds and return a short help
std::string help_string(void);
};
#endif