ESO Recipe Execution Tool  3.13
Functions
EsoRex Plugin Processing Functions

Functions

cpl_msg_severity message_severity (cpl_parameterlist *param_list, int flag)
 Sets the message severity level for the terminal. More...
 
cpl_frameset * er_frameset_load (const char *name, cpl_frameset *set, int flag_check_sof_exist)
 Create a new frame set from a set of frames file. More...
 
int plugin_process_plugin (cpl_parameterlist *caller_parameters, char *plugin_name, er_stringarray_t *sof_filename_list, int argc, char *argv[])
 Process the Plugin. More...
 
void er_enlarge (const char *fn, char **pptr, int msize)
 Enlarge memory buffer. More...
 

Detailed Description

EsoRex Plugin Processing Functions

Function Documentation

void er_enlarge ( const char *  fn,
char **  pptr,
int  msize 
)

Enlarge memory buffer.

Parameters
fnname of caller
pptraddr. of pointer to allocated memory buffer
msizenew (increased) size for memory buffer
Returns
0 if successfull, !=0 otherwise

This function frees the currently allocated space and uses the pointer 'mem_pntr' to point to newly allocated memory

cpl_frameset* er_frameset_load ( const char *  name,
cpl_frameset *  set,
int  flag_check_sof_exist 
)

Create a new frame set from a set of frames file.

Parameters
nameInput file path.
setFrame set to be updated with the contents of name.
flag_check_sof_existBoolean indicating if an error will be produced if the the Set-of-Frames is missing.
Returns
Pointer to the newly created frame set if set was NULL, or the updated set set. In case an error occurred the return value is NULL.

The function reads the given input file filename and either, if NULL is passed for set, creates a new frame set from its contents, or updates set, if set points to an already existing frame set.

Note
The current format of the set of frames file is as follows:
  • One frame description per line.
  • Each frame description consists of an absolute file path followed by the frame tag and, optionally, the group the frame belongs to.
  • Currently the only defined group tags are RAW, CALIB and PRODUCT.
  • The individual fields are separated by whitespace.
  • Blank lines are ignored.
  • Lines that begin with a hash (#) are treated as comment lines.
cpl_msg_severity message_severity ( cpl_parameterlist *  param_list,
int  flag 
)

Sets the message severity level for the terminal.

Parameters
param_listA list of the command line parameters
flag= 1, get level for logging = 2, get level for terminal messages

This function takes the list of all the command line parameters, and checks for the existence of one to set the terminal message reporting level. If it exists, the log-level is set to the requested value.

int plugin_process_plugin ( cpl_parameterlist *  caller_parameters,
char *  plugin_name,
er_stringarray_t sof_filename_list,
int  argc,
char *  argv[] 
)

Process the Plugin.

Parameters
caller_parametersCaller parameters
plugin_nameName of Plugin to process
sof_filename_listList of strings with SOF filenames
argcCount of remaining arguments from cmdl
argvHandle to remaining arguments from cmdl
Returns
0 if successfull, !=0 otherwise

Processes a Plugin. Write more here...