Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

colvarscript.h File Reference

#include <string>
#include <vector>
#include <map>
#include "colvarmodule.h"
#include "colvarvalue.h"
#include "colvarbias.h"
#include "colvarproxy.h"
#include "colvarscript_commands.h"

Go to the source code of this file.

Compounds

class  colvarscript

Defines

#define COLVARSCRIPT_ERROR   -1
#define COLVARSCRIPT_OK   0
#define CVSCRIPT_ENUM_COMM(COMM)   COMM,
#define CVSCRIPT(COMM, HELP, N_ARGS_MIN, N_ARGS_MAX, ARGS, FN_BODY)   CVSCRIPT_ENUM_COMM(COMM)

Functions

colvarscriptcolvarscript_obj ()
 Get a pointer to the main colvarscript object. More...

colvarcolvar_obj (void *pobj)
 Get a pointer to the colvar object pointed to by pobj. More...

colvarbiascolvarbias_obj (void *pobj)
 Get a pointer to the colvarbias object pointed to by pobj. More...

int run_colvarscript_command (int objc, unsigned char *const objv[])
 Generic wrapper for string-based scripting. More...

const char * get_colvarscript_result ()
 Get the string result of a script call. More...


Define Documentation

#define COLVARSCRIPT_ERROR   -1
 

Definition at line 24 of file colvarscript.h.

Referenced by bin.

#define COLVARSCRIPT_OK   0
 

Definition at line 25 of file colvarscript.h.

#define CVSCRIPT COMM,
HELP,
N_ARGS_MIN,
N_ARGS_MAX,
ARGS,
FN_BODY       CVSCRIPT_ENUM_COMM(COMM)
 

#define CVSCRIPT_ENUM_COMM COMM       COMM,
 


Function Documentation

colvar* colvar_obj void *    pobj [inline, static]
 

Get a pointer to the colvar object pointed to by pobj.

Definition at line 1421 of file colvarscript.h.

colvarbias* colvarbias_obj void *    pobj [inline, static]
 

Get a pointer to the colvarbias object pointed to by pobj.

Definition at line 1428 of file colvarscript.h.

colvarscript* colvarscript_obj   [inline, static]
 

Get a pointer to the main colvarscript object.

Definition at line 1414 of file colvarscript.h.

Referenced by cvscript_command_arghelp, cvscript_command_full_help, cvscript_command_help, cvscript_command_n_args_max, cvscript_command_n_args_min, cvscript_command_names, and cvscript_command_rethelp.

const char* get_colvarscript_result  
 

Get the string result of a script call.

Definition at line 1722 of file colvarscript.C.

int run_colvarscript_command int    objc,
unsigned char *const    objv[]
 

Generic wrapper for string-based scripting.

Definition at line 1707 of file colvarscript.C.


Generated on Fri Mar 29 02:46:34 2024 for VMD (current) by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002