LSEPW_evt0.h File Reference

Adds (writes) events to the event datagram in primary format 0. More...

Typedefs
typedef struct _LSEPW_dgmFwServices	LSEPW_dgmFwServices
typedef struct _LSEPW	LSEPW
typedef struct _LSEW_dgmFw	LSEW_dgmFw
Functions
int	LSEPW_evt0_sizeof (unsigned int max_level, void *cfg)
	Returns the size, in bytes, of the control structure needed to supprot the specified format level.
int	LSEPW_evt0_construct (void *ctxs[16], unsigned int max_level, void *mem, const void *cfg, LSEW_dgmFw *dgmFw, const LSEPW_dgmFwServices *defaults, LSEPW *lsepw)
	Translates the event format level to a set of datagram services and initializes the context parameter.
int	LSEPW_evt0_level_set (void *ctxs[16], unsigned int level, LSEW_dgmFw *dgmFw, const LSEPW_dgmFwServices *defaults, LSEPW *lsepw)
	Sets the output compression level.

---

Detailed Description

Adds (writes) events to the event datagram in primary format 0.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: LSEPW_evt0.h,v 1.5 2007/10/16 21:52:12 russell Exp $

---

Function Documentation

int LSEPW_evt0_construct	(	void *	ctxs[16],
		unsigned int	max_level,
		void *	mem,
		const void *	cfg,
		LSEW_dgmFw *	dgmFw,
		const LSEPW_dgmFwServices *	defaults,
		LSEPW *	lsepw
	)

Translates the event format level to a set of datagram services and initializes the context parameter.

Return values:

	0,success
	-1,Specified	level is not supported
	-2,Compression	construction failed

Parameters:

	ctxs	The array of contexts to be initialized
	max_level	The format level, also the initial level selected
	mem	The memory to carve the contexts from
	cfg	Additional configuration information
	dgmFw	The datagram framework handle
	defaults	The set of default LSEPW datagram services
	lsepw	The context parameter for the LSEPW datagram services

References CDFP_construct(), and LSEPW_evt0_level_set().

Referenced by LSEPW_constructC().

int LSEPW_evt0_level_set	(	void *	ctxs[16],
		unsigned int	level,
		LSEW_dgmFw *	dgmFw,
		const LSEPW_dgmFwServices *	defaults,
		LSEPW *	lsepw
	)

Sets the output compression level.

Return values:

	0,success
	-1,failure

Parameters:

	ctxs	The array of previously initialized user contexts
	level	The format level
	dgmFw	The datagram framework handle
	defaults	The set of default LSEPW datagram services
	lsepw	The context parameter for the LSEPW datagram services

References _LSEPW_dgmFwServices::beg, beg8_add(), _LSEPW_dgmFwServices::end, _LSEPW_dgmFwServices::evt, evt0_add(), evt1_add(), evt2_add(), evt3_add(), evt4_add(), evt5_add(), evt8_add(), and _LSEPW_dgmFwServices::usr.

Referenced by LSEPW_evt0_construct(), and LSEPW_levelSet().

int LSEPW_evt0_sizeof	(	unsigned int	level,
		void *	cfg
	)

Returns the size, in bytes, of the control structure needed to supprot the specified format level.

Returns:

The size, in bytes, of the compression structure

Parameters:

	level	The maximum format level to support
	cfg	Level specific configuration parameter

References CDFP_sizeof().

Referenced by LSEPW_constructC(), and LSEPW_sizeof().