Classes | Namespaces | Typedefs | Functions | Variables
PlumedMainInitializer.h File Reference

Classes

struct  plumed_nothrow_handler
 
struct  plumed_plumedmain_function_holder
 Container for plumedmain function pointers (create, cmd and finalize). More...
 
struct  plumed_symbol_table_type
 Container for symbol table. More...
 

Namespaces

 PLMD
 

Typedefs

typedef void(* plumed_cmd_pointer) (void *, const char *, const void *)
 
typedef void *(* plumed_create_pointer) (void)
 
typedef void(* plumed_finalize_pointer) (void *)
 

Functions

void plumed_plumedmain_cmd (void *plumed, const char *key, const void *val)
 Send a command key and a pointer val to a void pointer returned by plumed_plumedmain_create. More...
 
void * plumed_plumedmain_create ()
 Constructs a plumed object. More...
 
void plumed_plumedmain_finalize (void *plumed)
 Finalize a void pointer returned by plumed_plumedmain_create. More...
 
void plumed_symbol_table_init ()
 Function that makes sure that plumed_symbol_table is initialized. More...
 

Variables

plumed_symbol_table_type plumed_symbol_table
 Static symbol table that is accessed by the plumed loader. More...
 

Typedef Documentation

◆ plumed_cmd_pointer

typedef void(* plumed_cmd_pointer) (void *, const char *, const void *)

◆ plumed_create_pointer

typedef void*(* plumed_create_pointer) (void)

◆ plumed_finalize_pointer

typedef void(* plumed_finalize_pointer) (void *)

Function Documentation

◆ plumed_plumedmain_cmd()

void plumed_plumedmain_cmd ( void *  plumed,
const char *  key,
const void *  val 
)

Send a command key and a pointer val to a void pointer returned by plumed_plumedmain_create.

◆ plumed_plumedmain_create()

void* plumed_plumedmain_create ( )

Constructs a plumed object.

This function returns a void pointer that can be used in plumed_plumedmain_cmd and plumed_plumedmain_finalize.

◆ plumed_plumedmain_finalize()

void plumed_plumedmain_finalize ( void *  plumed)

Finalize a void pointer returned by plumed_plumedmain_create.

◆ plumed_symbol_table_init()

void plumed_symbol_table_init ( )

Function that makes sure that plumed_symbol_table is initialized.

Can be called multiple times.

Variable Documentation

◆ plumed_symbol_table

plumed_symbol_table_type plumed_symbol_table

Static symbol table that is accessed by the plumed loader.

Notice that this table is initialized with a static object construction. In principle, it should be accessed by other programs dlopening the plumed kernel. In that case, it is guaranteed to be already initialized. However, when accessed directly it might be safer to first call plumed_symbol_table_init.