libRASCH

Home   General About libRASCH/News Design Screen shots Sample programs (with source code) License   Download libRASCH Tools   Documentation User Developer   Resources Mailing list Supported Formats Plugins Status Links   Contact About this site   Last updated Tue Mar 27 23:03:52 2007

pl_general.h File Reference Include dependency graph for pl_general.h: This graph shows which files directly or indirectly include this file: Go to the source code of this file. Defines #define  ra_alloc_mem(x)   malloc(x) #define  ra_free_mem(x)   free(x) Functions meta_info *  get_meta_info (int id)   return meta-info int  find_ra_info_by_name (value_handle vh, const char *c)   look for info by name int  get_ra_info_id_ascii_by_id (long id, char *id_ascii)   returns ASCII-id for numeric id void  split_filename (const char *file, char sep, char *dir, char *name, char *ext)   splits path in parts void  set_one_session (struct ra_meas *meas, const char *name, const char *desc)   set one session in a measurement (helper function) void  free_session_rec (struct ra_rec *rh)   free recordings memory int  fill_predef_class_info (long id, value_handle vh_id, value_handle vh_name, value_handle vh_desc) int  fill_predef_class_info_ascii (const char *ascii_id, value_handle vh_name, value_handle vh_desc) long  get_class_id (const char *ascii_id) int  fill_predef_prop_info (int prop, value_handle vh_id, value_handle vh_type, value_handle vh_len, value_handle vh_name, value_handle vh_desc, value_handle vh_unit, value_handle vh_use_minmax, value_handle vh_min, value_handle vh_max)   get infos for pre-defined event-properties int  fill_predef_prop_info_ascii (const char *ascii_id, value_handle vh_type, value_handle vh_len, value_handle vh_name, value_handle vh_desc, value_handle vh_unit, value_handle vh_use_minmax, value_handle vh_min, value_handle vh_max) long  get_prop_id (const char *ascii_id) Detailed Description The header file contains meta-infos about infos which are handled by libRASCH. Author: Raphael Schneider (rasch@med1.med.tum.de) Definition in file pl_general.h. Define Documentation #define ra_alloc_mem (  x   )     malloc(x)   Definition at line 478 of file pl_general.h. Referenced by find_meas(), ra_value_set_double_array(), ra_value_set_long_array(), ra_value_set_short_array(), ra_value_set_string(), ra_value_set_string_array(), ra_value_set_string_array_utf8(), ra_value_set_string_utf8(), ra_value_set_vh_array(), ra_value_set_voidp_array(), set_one_session(), and set_option(). #define ra_free_mem (  x   )     free(x)   Definition at line 479 of file pl_general.h. Referenced by close_plugins(), free_mem(), free_session_rec(), ra_meas_close(), ra_meas_close_find(), and set_option(). Function Documentation int fill_predef_class_info (  long  id, value_handle  vh_id, value_handle  vh_name, value_handle  vh_desc )    Definition at line 229 of file pl_general.c. References event_class_desc::ascii_id, event_class_desc::desc, event_class_desc::name, and ra_value_set_string(). int fill_predef_class_info_ascii (  const char *  ascii_id, value_handle  vh_name, value_handle  vh_desc )    Definition at line 255 of file pl_general.c. References event_class_desc::desc, event_class_desc::name, and ra_value_set_string(). Referenced by ra_class_add_predef(). int fill_predef_prop_info (  int  prop, value_handle  vh_id, value_handle  vh_type, value_handle  vh_len, value_handle  vh_name, value_handle  vh_desc, value_handle  vh_unit, value_handle  vh_use_minmax, value_handle  vh_min, value_handle  vh_max )    Parameters: <prop>  id of pre-defined event-property <set_id>  receive id-string of event-set <set_name>  receive name of event-set <set_desc>  receive description of event-set <event_type>  receive type of event <prop_id>  receive id-string of event-property <prop_name>  receive name of event-property <prop_desc>  receive description of event-property <val_type>  receive type of event-property value <use_minmax>  receive flag if min and max receive valid values <min>  receive minimum value of event-property <max>  receive maximum value of event-property <unit>  receive unit of event-property Function returns (by setting values in function arguments) infos for pre-defined event-properties. Definition at line 321 of file pl_general.c. References event_prop_desc::ascii_id, event_prop_desc::desc, event_prop_desc::max_value, event_prop_desc::min_value, event_prop_desc::name, event_prop_desc::num_values, ra_value_set_double(), ra_value_set_long(), ra_value_set_string(), event_prop_desc::unit, event_prop_desc::use_minmax, and event_prop_desc::val_type. int fill_predef_prop_info_ascii (  const char *  ascii_id, value_handle  vh_type, value_handle  vh_len, value_handle  vh_name, value_handle  vh_desc, value_handle  vh_unit, value_handle  vh_use_minmax, value_handle  vh_min, value_handle  vh_max )    Definition at line 354 of file pl_general.c. References event_prop_desc::desc, event_prop_desc::max_value, event_prop_desc::min_value, event_prop_desc::name, event_prop_desc::num_values, ra_value_set_double(), ra_value_set_long(), ra_value_set_string(), event_prop_desc::unit, event_prop_desc::use_minmax, and event_prop_desc::val_type. Referenced by ra_prop_add_predef(). int find_ra_info_by_name (  value_handle  vh, const char *  c )    Parameters: <vh>  value-handle receiving the info meta-infos <c>  name of the info looked for The function search for a given info and set the info meta-info in a given value-handle. Definition at line 68 of file pl_general.c. References ra_value::desc, ra_value::name, ra_value_reset(), set_meta_info(), and ra_value::utype. Referenced by ra_info_get_by_name(). void free_session_rec (  struct ra_rec *  rh  )    Parameters: <rh>  pointer to the recording struct Function frees recursively the memory allocated for the recording structs. Definition at line 213 of file pl_general.c. References ra_rec::child, free_session_rec(), ra_rec::next, and ra_free_mem. Referenced by free_session_rec(), and ra_meas_close(). long get_class_id (  const char *  ascii_id  )    Definition at line 280 of file pl_general.c. Referenced by ra_class_add(), and read_sets_xml(). struct meta_info* get_meta_info (  int  id  )    Parameters: <id>  id for which meta-info is looked for Returns meta-info for info with the id 'id'. Definition at line 52 of file pl_general.c. References comp_func(). Referenced by get_lib_info(), get_plugin_info(), and ra_info_set(). long get_prop_id (  const char *  ascii_id  )    Definition at line 387 of file pl_general.c. Referenced by ra_prop_add(). int get_ra_info_id_ascii_by_id (  long  id, char *  id_ascii )    Parameters: <id>  id for which is looked for <id_ascii>  pointer to char buffer receiving the ASCII-id The function returns (in parameter 'id_ascii') the ASCII name for a numeric id. Definition at line 106 of file pl_general.c. void set_one_session (  struct ra_meas *  meas, const char *  name, const char *  desc )    Parameters: <meas>  pointer to a measuerment struct <name>  name of the session <desc>  description of the session Helper function to set one session with just the information needed by libRASCH. Definition at line 188 of file pl_general.c. References ra_session::desc, ra_rec::handle_id, ra_rec::meas, ra_session::name, ra_meas::num_sessions, ra_alloc_mem, RA_HANDLE_REC, RA_VALUE_DESC_MAX, RA_VALUE_NAME_MAX, ra_session::root_rec, and ra_meas::sessions. void split_filename (  const char *  file, char  sep, char *  dir, char *  name, char *  ext )    Parameters: <file>  complete filename which will be split <sep>  file seperator used <dir>  buffer receiving the directory part <name>  buffer receiving the file name <ext>  buffer receiving the file extension The function splits the elements of a file-path in: (1) directory, (2) file name and (3) file extension. The fileseperator can be choosen. Definition at line 141 of file pl_general.c.