xfc_rto.h File Reference

Filter run time options, interface prototypes. More...

Typedefs
typedef enum _XfcRtoStyle	XfcRtoStyle
	Typedef for enum _XfcRtoStyle.
Enumerations
enum	_XfcRtoStyle {   XFC_RTO_STYLE_K_PRD = 0,   XFC_RTO_STYLE_K_INS = 1,   XFC_RTO_STYLE_K_DEV = 2 }
	The style of filter being used. More...
Functions
int	xfc_rto_sizeof (void)
	Returns the size, in bytes, of an XfcRto structure.
int	xfc_rto_parse (XfcRto *rto, XfcRtoStyle style, int argc, char *const argv[])
	Examines the command line parameters and fills the print control structure.
int	xfc_rto_edm_level_get (const XfcRto *rto)
	Return the EDM reporting level.
void	xfc_rto_schema_set (XfcRto *rto, int schema_id, int instance_id)
	Return the EDM reporting level.
void	xfc_rto_usage_report (const char *name, XfcRtoStyle style)
	Gives a terse explanation of this commands usage.

---

Detailed Description

Filter run time options, interface prototypes.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: xfc_rto.h,v 1.2 2007/10/11 18:27:32 russell Exp $

---

Enumeration Type Documentation

enum _XfcRtoStyle

The style of filter being used.

Enumerator:

XFC_RTO_STYLE_K_PRD	Production style
XFC_RTO_STYLE_K_INS	Instrumented style
XFC_RTO_STYLE_K_DEV	Development/Diagnostic/Debug style

---

Function Documentation

int xfc_rto_edm_level_get

(

const XfcRto *

rto

)

Return the EDM reporting level.

Returns:

The EDM reporting level

Parameters:

rto

The Xfc runtime options structure

References _XfcRto::level.

int xfc_rto_parse	(	XfcRto *	rto,
		XfcRtoStyle	style,
		int	argc,
		char *const	argv[]
	)

Examines the command line parameters and fills the print control structure.

fn int xfc_rto_parse (XfcRto *rto, XfcRtoStyle style, int argc, char *const argv[])

Return values:

	0	Everything is okay.
	-1	Incorrect command usage. Usually this means that the input file name was absent.

Parameters:

	rto	The runtime options structure. HELLO
	style	The filter style. This determines the set of available options
	argc	The number of command line parameters.
	argv	The array of pointers to the command line parameters.

References _XfcRto::clevel, _XfcRto::dgmfile, _XfcRto::efa_post_cnt, get_edm_level(), get_reporting_options(), get_ss_to_display(), get_ss_to_print(), _XfcRto::level, loadLib(), _XfcRto::mode, _XfcRto::name, _XfcRto::ofile, _XfcRto::options, _XfcRto::rate, _XfcRto::ss_to_display, _XfcRto::ss_to_print, _XfcRto::to_loop, _XfcRto::to_process, _XfcRto::to_skip, _XfcRto::type, _XfcRto::verbose, and _XfcRto::vetoes.

void xfc_rto_schema_set	(	XfcRto *	rto,
		int	schema_id,
		int	instance_id
	)

Return the EDM reporting level.

Returns:

The EDM reporting level

Parameters:

	rto	The Xfc runtime options structure
	schema_id	The filter's schema ID
	instance_id	The filter's instance ID

References _XfcRto::dbInstanceId, and _XfcRto::dbSchemaId.

int xfc_rto_sizeof

(

void

)

Returns the size, in bytes, of an XfcRto structure.

Returns:

The size, in bytes, of an XfcRto structure

void xfc_rto_usage_report	(	const char *	name,
		XfcRtoStyle	style
	)

Gives a terse explanation of this commands usage.

Parameters:

	name	The name of the main program
	style	The filter style (production, development, instrumented)

References XFC_RTO_STYLE_K_DEV.