xfc_rto.c File Reference

Host based run time options filler. More...

#include <xfc_rto.h>
#include <xfc_rto_def.h>
#include <xfc_print_def.h>
#include <EFC/EDM.h>
#include <EFC/EFC_display.h>
#include <EDS/EDSD_print.h>
#include <EDS/io/EBF_stream.h>
#include <CDM/CDM_pubdefs.h>
#include <PBS/MBA.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>

Typedefs
typedef struct _TASK_tcb	TASK_tcb
Functions
static unsigned int	get_reporting_options (const char *opts, int *cnt)
	Returns a bit mask of the reporting options.
static int	get_edm_level (const char *opts)
	Uses the input string to find the diagnostic reporting level.
static unsigned int	get_ss_to_print (const char *opts)
	Uses the input string to find the subsystems to print.
static unsigned int	get_ss_to_display (const char *opts)
	Uses the input string to find the subsystem display to make.
static int	loadLib (const char *library_name, int verbose)
	Dynamically loads the specified configuration library.
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

Host based run time options filler.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: xfc_rto.c,v 1.5 2011/03/28 20:51:00 russell Exp $

---

Function Documentation

static int get_edm_level

(

const char *

opts

)

[static]

Uses the input string to find the diagnostic reporting level.

Returns:

The reporting level

Parameters:

opts

The options string, The options are I Informational D Debug W Warning messages F Fatal anything else, no reporting

Referenced by xfc_rto_parse().

static unsigned int get_reporting_options	(	const char *	opts,
		int *	cnt
	)			[static]

Returns a bit mask of the reporting options.

Returns:

A bit mask of the reporting options

Parameters:

	opts	The option string to parse
	cnt	Returned as the EFA buffering count

References XFC_PRINT_OPTS_M_RESULTS_EVENT, and XFC_PRINT_OPTS_M_RESULTS_SUMMARY.

Referenced by xfc_rto_parse().

static unsigned int get_ss_to_display

(

const char *

opts

)

[static]

Uses the input string to find the subsystem display to make.

Returns:

The reporting level

Parameters:

opts

The options string, The options are A ACD

Referenced by xfc_rto_parse().

static unsigned int get_ss_to_print

(

const char *

opts

)

[static]

Uses the input string to find the subsystems to print.

Returns:

The reporting level

Parameters:

opts

The options string, The options are A ACD C CAL G GEM T TKR

Referenced by xfc_rto_parse().

static int loadLib	(	const char *	library_name,
		int	verbose
	)			[static]

Dynamically loads the specified configuration library.

Return values:

	0,success
	-1,failure

Parameters:

	library_name	The name of the library to load
	verbose	The verbosity level

Referenced by xfc_rto_parse().

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.