UVES Pipeline Reference Manual  5.4.0
Functions
Print CPL objects

Functions

cpl_error_code uves_print_uves_propertylist (const uves_propertylist *pl, long low, long high)
 Print a property list.
cpl_error_code uves_print_cpl_property (const cpl_property *prop)
 Print a property.
cpl_error_code uves_print_cpl_frameset (const cpl_frameset *frames)
 Print a frame set.
cpl_error_code uves_print_cpl_frame (const cpl_frame *f)
 Print a frame.
const char * uves_tostring_cpl_frame_type (cpl_frame_type ft)
 Convert a frame type to a string.
const char * uves_tostring_cpl_frame_group (cpl_frame_group fg)
 Convert a frame group to a string.
const char * uves_tostring_cpl_frame_level (cpl_frame_level fl)
 Convert a frame level to a string.
const char * uves_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 uves_print_uves_propertylist ( const uves_propertylist pl,
long  low,
long  high 
)

Print a property list.

Parameters:
plThe property list to print.
lowIndex of first property to print.
highIndex 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 117 of file uves_dump.c.

References check, uves_msg, uves_print_cpl_property(), uves_propertylist_get_const(), uves_propertylist_get_size(), and uves_propertylist_is_empty().

cpl_error_code uves_print_cpl_property ( const cpl_property *  prop)

Print a property.

Parameters:
propThe property to print.
Returns:
CPL_ERROR_NONE iff OK.

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

Definition at line 153 of file uves_dump.c.

References check, and uves_msg.

Referenced by uves_print_uves_propertylist().

cpl_error_code uves_print_cpl_frameset ( const cpl_frameset *  frames)

Print a frame set.

Parameters:
framesFrame set to print
Returns:
CPL_ERROR_NONE iff OK.

This function prints all frames in a CPL frame set.

Definition at line 235 of file uves_dump.c.

References check, uves_msg, and uves_print_cpl_frame().

Referenced by uves_initialize().

cpl_error_code uves_print_cpl_frame ( const cpl_frame *  f)

Print a frame.

Parameters:
fFrame to print
Returns:
CPL_ERROR_NONE iff OK.

This function prints a CPL frame.

Definition at line 277 of file uves_dump.c.

References uves_msg, uves_msg_debug, uves_tostring_cpl_frame_group(), uves_tostring_cpl_frame_level(), and uves_tostring_cpl_frame_type().

Referenced by uves_print_cpl_frameset().

const char* uves_tostring_cpl_frame_type ( cpl_frame_type  ft)

Convert a frame type to a string.

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

Definition at line 314 of file uves_dump.c.

Referenced by uves_print_cpl_frame().

const char* uves_tostring_cpl_frame_group ( cpl_frame_group  fg)

Convert a frame group to a string.

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

Definition at line 334 of file uves_dump.c.

Referenced by uves_print_cpl_frame().

const char* uves_tostring_cpl_frame_level ( cpl_frame_level  fl)

Convert a frame level to a string.

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

Definition at line 355 of file uves_dump.c.

Referenced by uves_print_cpl_frame().

const char* uves_tostring_cpl_type ( cpl_type  t)