Debug
[Kernel Functionality]

Collaboration diagram for Debug:

Classes
class	DEBUG_LIST
	Defines a simple list pointer, which allows all active lists to be scanned. More...
Functions
void	clear_debug_lists ()
	Clears the DEBUG_LISTs.
void	debug_dist (double d, FILE *fp=debug_file_ptr)
	Prints a double representing a signed distance.
void	debug_entity (ENTITY const *SPAptr, FILE *=debug_file_ptr)
	Print out the given entity and all its subsidiary structure.
void	debug_int (char const *title, int val, FILE *fp)
	Prints an integer with the given title to the output file.
char const *	debug_leader ()
	Prints to the output file a pointer to a static string containing a suitable blank title string for the second and subsequent lines of an item.
void	debug_new_pointer (ENTITY const *SPAptr, FILE *fp)
	Prints to the output file an ENTITY pointer.
void	debug_new_pointer (char const *title, ENTITY const *SPAptr, FILE *fp)
	Prints to the output file an ENTITY pointer.
void	debug_newline (FILE *fp=debug_file_ptr)
	Prints a newline character.
void	debug_norm (double d, FILE *fp=debug_file_ptr)
	Prints a real representing a normalized, dimensionless quantity.
void	debug_old_pointer (char const *title, ENTITY const *SPAptr, FILE *fp)
	Prints to the output file an ENTITY pointer.
void	debug_pointer (void const *pv, FILE *fp=debug_file_ptr)
	Prints a pointer.
void	debug_pointer_str (void const *pv, char *str)
	Prints a pointer as a string.
void	debug_real (double d, FILE *fp=debug_file_ptr)
	Prints a real number (double) with appropriate precision.
void	debug_real (char const *title, double val, FILE *fp)
	Prints out a real number with title and newline.
void	debug_real_str (double d, char *str)
	Prints a real number (double) with appropriate precision to a string.
void	debug_sib_pointer (char const *title, ENTITY const *SPAptr, FILE *fp)
	Prints to the output file an ENTITY pointer.
void	debug_size (ENTITY const *SPAptr, FILE *=debug_file_ptr)
	Prints the size of the ENTITY.
void	debug_string (char const *title, char const *str, FILE *fp)
	Prints to the output file a string value with the given title.
void	debug_time (FILE *fp=debug_file_ptr)
	Displays elapsed time since the last call to debug_time_init or debug_time, also resets the internal timer.
void	debug_time_init ()
	Resets the internal timer for timing operations using debug_time.
Variables
FILE *	debug_file_ptr
	Pointer to default debug file.

---

Function Documentation

void clear_debug_lists

(

)

Clears the DEBUG_LISTs.

Effect: System routine

include <debug.hxx>

void debug_dist	(	double	d,
		FILE *	fp = debug_file_ptr
	)

Prints a double representing a signed distance.

Role: The distance is considered to be zero if its magnitude is less than SPAresabs.

Parameters:

	d	value to print.
	fp	file pointer.

include <debugmsc.hxx>

void debug_entity	(	ENTITY const *	SPAptr,
		FILE *	= debug_file_ptr
	)

Print out the given entity and all its subsidiary structure.

Role: Prints to the specified output file the debug information for an entity and all its subsidiary entities. Effect: System routine

Parameters:

	SPAptr	entity.
	debug_file_ptr	file pointer.

include <debug.hxx>

void debug_int	(	char const *	title,
		int	val,
		FILE *	fp
	)

Prints an integer with the given title to the output file.

Effect: System routine

Parameters:

	title	title.
	val	integer value.
	fp	file pointer.

include <debug.hxx>

char const* debug_leader

(

)

Prints to the output file a pointer to a static string containing a suitable blank title string for the second and subsequent lines of an item.

Effect: System routine

include <debug.hxx>

void debug_new_pointer	(	ENTITY const *	SPAptr,
		FILE *	fp
	)

Prints to the output file an ENTITY pointer.

Role: Outputs an ENTITY pointer and enters it into the list. This pointer can be preceded by a title and followed by a new line.

Effect: System routine

Parameters:

	SPAptr	entity pointer.
	fp	file pointer.

include <debug.hxx>

void debug_new_pointer	(	char const *	title,
		ENTITY const *	SPAptr,
		FILE *	fp
	)

Prints to the output file an ENTITY pointer.

Role: Prints to the specified output file a formatted entity pointer, adding it to the debug lists if it is necessary. The pointer is preceded by a title and followed by a new line.

Effect: System routine

Parameters:

	title	title
	SPAptr	entity.
	fp	file pointer.

include <debug.hxx>

void debug_newline

(

FILE *

fp = debug_file_ptr

)

Prints a newline character.

Parameters:

fp

file pointer.

include <debugmsc.hxx>

void debug_norm	(	double	d,
		FILE *	fp = debug_file_ptr
	)

Prints a real representing a normalized, dimensionless quantity.

Role: The quantity is considered to be zero if its magnitude is less than SPAresnor.

Parameters:

	d	double to print.
	fp	file pointer.

include <debugmsc.hxx>

void debug_old_pointer	(	char const *	title,
		ENTITY const *	SPAptr,
		FILE *	fp
	)

Prints to the output file an ENTITY pointer.

Role: Prints to the specified output file a formatted entity pointer, which should already be contained in the debug lists. The pointer is preceded by a title and followed by a new line.

Effect: System routine

Parameters:

	title	title
	SPAptr	entity.
	fp	file pointer.

include <debug.hxx>

void debug_pointer	(	void const *	pv,
		FILE *	fp = debug_file_ptr
	)

Prints a pointer.

Role: By default, prints the pointer as a relative address. If the option debug_absolute_addresses is on, an absolute address is used.

Parameters:

	pv	pointer to print.
	fp	file pointer.

include <debugmsc.hxx>

void debug_pointer_str	(	void const *	pv,
		char *	str
	)

Prints a pointer as a string.

Role: By default, prints the pointer as a relative address. If the option debug_absolute_addresses is on, an absolute address is used.

Parameters:

	pv	pointer to print.
	str	character pointer (string).

include <debugmsc.hxx>

void debug_real	(	double	d,
		FILE *	fp = debug_file_ptr
	)

Prints a real number (double) with appropriate precision.

Parameters:

	d	double to print.
	fp	file pointer.

include <debugmsc.hxx>

void debug_real	(	char const *	title,
		double	val,
		FILE *	fp
	)

Prints out a real number with title and newline.

Role: Outputs a real number. The value can be preceded by a title and followed by a new line.

Effect: System routine

Parameters:

	title	title.
	val	real value.
	fp	file pointer.

include <debug.hxx>

void debug_real_str	(	double	d,
		char *	str
	)

Prints a real number (double) with appropriate precision to a string.

Parameters:

	d	double to print.
	str	character pointer (string).

include <debugmsc.hxx>

void debug_sib_pointer	(	char const *	title,
		ENTITY const *	SPAptr,
		FILE *	fp
	)

Prints to the output file an ENTITY pointer.

Role: Prints to the specified output file a formatted entity pointer, adding it to the debug lists if debug_siblings is TRUE and it is necessary. The pointer is preceded by a title and followed by a new line.

Effect: System routine

Parameters:

	title	title
	SPAptr	entity.
	fp	file pointer.

include <debug.hxx>

void debug_size	(	ENTITY const *	SPAptr,
		FILE *	= debug_file_ptr
	)

Prints the size of the ENTITY.

Role: Prints to the specified output file the size of an entity and all its subsidiary entities. Output information also includes the number of each type of subsidiary entity.

Effect: System routine

Parameters:

	SPAptr	entity.
	debug_file_ptr	file pointer.

include <debug.hxx>

void debug_string	(	char const *	title,
		char const *	str,
		FILE *	fp
	)

Prints to the output file a string value with the given title.

Effect: System routine

Parameters:

	title	title.
	str	string value.
	fp	file pointer.

include <debug.hxx>

void debug_time

(

FILE *

fp = debug_file_ptr

)

Displays elapsed time since the last call to debug_time_init or debug_time, also resets the internal timer.

Parameters:

fp

file pointer.

See also:

debug_time_init

include <debugmsc.hxx>

void debug_time_init

(

)

Resets the internal timer for timing operations using debug_time.

See also:

debug_time

include <debugmsc.hxx>

---

Variable Documentation

FILE* debug_file_ptr

Pointer to default debug file.