descriptions.ic File Reference

Static inline functions that calculate some simple component properties. More...

#include <AG_descriptions_s.h>
#include <string.h>

Functions
static size_t	sizeofCpt (const CptDescription *cd)
	Returns the volume of the component.
static void	clearCpt (void *cpt, const CptDescription *cd)
	Clears all the bits of the data block, assuming that it is described by the CptDescription.
static void	copyCpt (void *cpt, const void *source, const CptDescription *cd)
	Copy from source to dest.
static int	compareCpt (const void *cpt, const void *that, const CptDescription *cd)
	Compare two components.

---

Detailed Description

Static inline functions that calculate some simple component properties.

Author:

James Swain -- jswain@slac.stanford.edu

---

Function Documentation

void clearCpt	(	void *	cpt,
		const CptDescription *	cd
	)			[inline, static]

Clears all the bits of the data block, assuming that it is described by the CptDescription.

Parameters:

	cpt	Pointer to start of the component data
	cd	Description of the component registers

References sizeofCpt().

int compareCpt	(	const void *	this,
		const void *	that,
		const CptDescription *	cd
	)			[inline, static]

Compare two components.

Parameters:

	this	Pointer to one of the components being compared
	that	Pointer to the other component be compared
	cd	Description of the component registers

Return values:

	0	if identical
	non-zero	if different

References sizeofCpt().

void copyCpt	(	void *	dest,
		const void *	source,
		const CptDescription *	cd
	)			[inline, static]

Copy from source to dest.

Parameters:

	dest	Destination to copy to
	source	Place to copy from
	cd	Description of the component registers

References sizeofCpt().

size_t sizeofCpt

(

const CptDescription *

cd

)

[inline, static]

Returns the volume of the component.

Parameters:

cd

Description of the component registers

Returns:

Size of data volume required to hold the component

References CptDescription::nregs, and CptDescription::width.

Referenced by clearCpt(), compareCpt(), consumeAEMFile(), consumeDefaultFile(), consumeGEMFile(), consumeNormalFile(), and copyCpt().