Print CPL objects
[Xsh Specific Tools]

Functions

cpl_error_code xsh_print_cpl_propertylist (const cpl_propertylist *pl, long low, long high)
 Print a property list.
cpl_error_code xsh_print_cpl_property (const cpl_property *prop)
 Print a property.
cpl_error_code xsh_print_cpl_frameset (cpl_frameset *frames)
 Print a frame set.
cpl_error_code xsh_print_cpl_frame (const cpl_frame *f)
 Print a frame.
const char * xsh_tostring_cpl_frame_type (cpl_frame_type ft)
 Convert a frame type to a string.
const char * xsh_tostring_cpl_frame_group (cpl_frame_group fg)
 Convert a frame group to a string.
const char * xsh_tostring_cpl_frame_level (cpl_frame_level fl)
 Convert a frame level to a string.
const char * xsh_tostring_cpl_type (cpl_type t)
 Convert a CPL type to a string.

Detailed Description

Functions that enables dumping (using CPL's messaging system) some otherwise non-dumpable CPL objects


Function Documentation

cpl_error_code xsh_print_cpl_frame ( const cpl_frame *  f  ) 

Print a frame.

Parameters:
f Frame to print
Returns:
CPL_ERROR_NONE iff OK.

This function prints a CPL frame.

Definition at line 236 of file xsh_dump.c.

References xsh_msg, xsh_msg_dbg_low, xsh_tostring_cpl_frame_group(), xsh_tostring_cpl_frame_level(), and xsh_tostring_cpl_frame_type().

Referenced by xsh_end(), and xsh_print_cpl_frameset().

cpl_error_code xsh_print_cpl_frameset ( cpl_frameset *  frames  ) 

Print a frame set.

Parameters:
frames Frame set to print
Returns:
CPL_ERROR_NONE iff OK.

This function prints all frames in a CPL frame set.

Definition at line 199 of file xsh_dump.c.

References check, xsh_msg, and xsh_print_cpl_frame().

Referenced by xsh_begin().

cpl_error_code xsh_print_cpl_property ( const cpl_property *  prop  ) 

Print a property.

Parameters:
prop The property to print.
Returns:
CPL_ERROR_NONE iff OK.

This function prints a property's name, value and comment.

Definition at line 102 of file xsh_dump.c.

References check, and xsh_msg.

Referenced by xsh_print_cpl_propertylist().

cpl_error_code xsh_print_cpl_propertylist ( const cpl_propertylist *  pl,
long  low,
long  high 
)

Print a property list.

Parameters:
pl The property list to print.
low Index of first property to print.
high Index of first property not to print.
Returns:
CPL_ERROR_NONE iff OK.

This function prints all properties in the property list pl in the range from low (included) to high (not included) counting from zero.

Definition at line 64 of file xsh_dump.c.

References assure, check, xsh_msg, and xsh_print_cpl_property().

const char* xsh_tostring_cpl_frame_group ( cpl_frame_group  fg  ) 

Convert a frame group to a string.

Parameters:
fg Frame group to convert
Returns:
A textual representation of fg.

Definition at line 294 of file xsh_dump.c.

Referenced by xsh_print_cpl_frame().

const char* xsh_tostring_cpl_frame_level ( cpl_frame_level  fl  ) 

Convert a frame level to a string.

Parameters:
fl Frame level to convert
Returns:
A textual representation of fl.

Definition at line 322 of file xsh_dump.c.

Referenced by xsh_print_cpl_frame().

const char* xsh_tostring_cpl_frame_type ( cpl_frame_type  ft  ) 

Convert a frame type to a string.

Parameters:
ft Frame type to convert
Returns:
A textual representation of ft.

Definition at line 266 of file xsh_dump.c.

Referenced by xsh_print_cpl_frame().

const char* xsh_tostring_cpl_type ( cpl_type  t  ) 

Convert a CPL type to a string.

Parameters:
t Type to convert
Returns:
A textual representation of t.

Definition at line 352 of file xsh_dump.c.

Referenced by subtract_background(), xsh_get_property_value(), xsh_polynomial_convert_from_table(), xsh_polynomial_regression_2d(), and xsh_select_table_rows().


Generated on 9 Mar 2011 for X-shooter Pipeline Reference Manual by  doxygen 1.6.1