GRBP_DB_print.h File Reference

Interface to the GRBP_DB printing routines. These are mainly diagnostic and debugging routines. More...

#include <GRBP_DB/GRBP_DB_window.h>

Typedefs
typedef enum _GRBP_DB_PRINTOPTS_M	GRBP_DB_PRINTOPTS_M
	Typedef for enum _GRBP_DB_PRINTOPTS_M.
Enumerations
enum	_GRBP_DB_PRINTOPTS_M {   GRBP_DB_PRINTOPTS_M_HDR = (1 << 0),   GRBP_DB_PRINTOPTS_M_PROBABILITY = (1 << 1),   GRBP_DB_PRINTOPTS_M_CACHE = (1 << 2),   GRBP_DB_PRINTOPTS_M_WINDOWLIST = (1 << 3),   GRBP_DB_PRINTOPTS_M_GRB = (1 << 4),   GRBP_DB_PRINTOPTS_M_GBMREPOINT = (1 << 5),   GRBP_DB_PRINTOPTS_M_ALL = 0xffffffff }
	Display options. More...
Functions
void	GRBP_DB_clientPrint (const GRBP_DB_clientSchema *schema, unsigned int opts)
	Prints the contents to the GRBP client-side database.
void	GRBP_DB_clientAllPrint (const GRBP_DB_clientSchemaAll *schema, unsigned int opts)
	Prints the contents of the GRBP client-side database.
void	GRBP_DB_serverPrint (const GRBP_DB_serverSchema *schema, unsigned int opts)
	Prints the contents to the GRBP server-side database.
void	GRBP_DB_serverAllPrint (const GRBP_DB_serverSchemaAll *schema, unsigned int opts)
	Prints the contents of the GRBP server-side database.

---

Detailed Description

Interface to the GRBP_DB printing routines. These are mainly diagnostic and debugging routines.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id

---

Typedef Documentation

GRBP_DB_PRINTOPTS_M

Typedef for enum _GRBP_DB_PRINTOPTS_M.

These are options passed into GRPB_DB_print and select which sub-pieces of the configuration are printed. They are in the form of bit masks. One can OR these options together to get multiple sub-pieces printed.

---

Enumeration Type Documentation

enum _GRBP_DB_PRINTOPTS_M

Display options.

Enumerator:

GRBP_DB_PRINTOPTS_M_HDR	Print standard header
GRBP_DB_PRINTOPTS_M_PROBABILITY	Print probability
GRBP_DB_PRINTOPTS_M_CACHE	Print photon cache
GRBP_DB_PRINTOPTS_M_WINDOWLIST	Print windows
GRBP_DB_PRINTOPTS_M_GRB	Print grb config
GRBP_DB_PRINTOPTS_M_GBMREPOINT	Print GBM repoint
GRBP_DB_PRINTOPTS_M_ALL	Print everything

---

Function Documentation

void GRBP_DB_clientAllPrint	(	const GRBP_DB_clientSchemaAll *	schema,
		unsigned int	opts
	)

Prints the contents of the GRBP client-side database.

Parameters:

	schema	The schema of the client-side database
	opts	Bit mask of print options

References GRBP_DB_clientPrint(), GRBP_DB_PRINTOPTS_M_HDR, hdr_print(), _GRBP_DB_clientSchemaAll::physics, and _GRBP_DB_clientSchemaAll::standard.

void GRBP_DB_clientPrint	(	const GRBP_DB_clientSchema *	schema,
		unsigned int	opts
	)

Prints the contents to the GRBP client-side database.

Parameters:

	schema	The schema of the client-side physics database
	opts	Bit mask of print options

References _GRBP_DB_clientSchema::cache, cache_print(), _GRBP_DB_clientSchema::gbmRepoint, _GRBP_DB_clientSchema::grb, grb_print(), GRBP_DB_PRINTOPTS_M_CACHE, GRBP_DB_PRINTOPTS_M_GBMREPOINT, GRBP_DB_PRINTOPTS_M_GRB, GRBP_DB_PRINTOPTS_M_PROBABILITY, GRBP_DB_PRINTOPTS_M_WINDOWLIST, _GRBP_DB_clientSchema::probability, probability_print(), _GRBP_DB_clientSchema::windowList, and windowList_print().

Referenced by GRBP_DB_clientAllPrint().

void GRBP_DB_serverAllPrint	(	const GRBP_DB_serverSchemaAll *	schema,
		unsigned int	opts
	)

Prints the contents of the GRBP server-side database.

Parameters:

	schema	The schema of the client-side database
	opts	Bit mask of print options

References GRBP_DB_PRINTOPTS_M_HDR, hdr_print(), and _GRBP_DB_serverSchemaAll::standard.

void GRBP_DB_serverPrint	(	const GRBP_DB_serverSchema *	schema,
		unsigned int	opts
	)

Prints the contents to the GRBP server-side database.

Parameters:

	schema	The schema of the client-side physics database
	opts	Bit mask of print options