Core access functions
[Runtime module API]


Detailed Description

Most module function use core library functions and variables.

Use these macros to access the core library and other global module variables.


Defines

#define gl_findfile   (*callback->file.find_file)
 Provide file search function.
#define gl_get_module_var   (*callback->get_module_var)
 Provides access to a global module variable.
#define gl_module_depends   (*callback->depends)
 Declare a module dependency.
#define set_callback(CT)   (callback=(CT))
 Defines the callback table for the module.


Define Documentation

#define gl_findfile   (*callback->file.find_file)

Provide file search function.

See also:
find_file()

Definition at line 314 of file gridlabd.h.

Referenced by import_cdf().

#define gl_get_module_var   (*callback->get_module_var)

Provides access to a global module variable.

See also:
global_getvar(), global_setvar()

Definition at line 309 of file gridlabd.h.

#define gl_module_depends   (*callback->depends)

Declare a module dependency.

This will automatically load the module if it is not already loaded.

Returns:
1 on success, 0 on failure

Definition at line 333 of file gridlabd.h.

#define set_callback ( CT   )     (callback=(CT))

Defines the callback table for the module.

Callback function provide module with direct access to important core functions.

See also:
struct s_callback

Definition at line 304 of file gridlabd.h.


GridLAB-DTM Version 2.0
An open-source project initiated by the US Department of Energy