---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > GRBP / V0-2-0

Constituent: grbpsiu     Tag: sun-gcc

---

         

---

GRBP_bitList.h File Reference

Maintains a bit list of elements, interface. More...

This graph shows which files directly or indirectly include this file:

Data Structures
struct	_GRBP_bitList
	A list of managed elements, maintained as an array of bit masks. More...
Defines
#define	GRBP_BITLIST_MASK(_bit)   ((unsigned int)(0x80000000) >> (_bit))
	Constructs a bit mask with _bit. The justication (in this case left) is consistent with the bit lists internal usage.
Typedefs
typedef _GRBP_bitList	GRBP_bitList
Functions
int	GRBP_bitListSizeof (int max)
	Computes the amount of memory to maintain a list of max elements.
unsigned char *	GRBP_bitListConstruct (GRBP_bitList *list, int max)
	Constructs (initializes) the list of max elements.
void	GRBP_bitListClearCount (GRBP_bitList *list, int from, int nbits)
	Clears the mbits from a specified starting position from.
static __inline unsigned int	GRBP__bitListMask (int bit)
	Constructs a bit mask with _bit. The justication (in this case left) is consistent with the bit lists internal usage.
static __inline void	GRBP__bitListMaskSet (unsigned int *masks, int bit)
	Sets the specified bit in an array of bit masks. The bit number must be within the array of the bit masks. No checking on the validity is performed.
static __inline void	GRBP__bitListMaskClear (unsigned int *masks, int bit)
	Clears the specified bit in an array of bit masks. The bit number must be within the array of the bit masks. No checking on the validity is performed.
static __inline void	GRBP__bitListClearAll (GRBP_bitList *list)
	Clears all bits in the specified bit list.
static __inline unsigned int	GRBP__bitListMasksMerge (unsigned int *merge, unsigned int *active, int nmasks)
	Creates a list masks that are in merged but not in active. The list of active masks is returned as the OR of the two lists. This function allows one to get bits that are not already in active, while at the same time updating active to be the complete set of bits.

---

Detailed Description

Maintains a bit list of elements, interface.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GRBP_bitList.h,v 1.1.1.1 2007/06/18 00:42:58 russell Exp $

---

Define Documentation

#define GRBP_BITLIST_MASK (  _bit   )     ((unsigned int)(0x80000000) >> (_bit))

Constructs a bit mask with _bit. The justication (in this case left) is consistent with the bit lists internal usage. Returns: The constructed bit mask Parameters: _bit  The bit number to set (0-31)

---

Function Documentation

static __inline void GRBP__bitListClearAll (  GRBP_bitList *  list  )  [static]

Clears all bits in the specified bit list. Parameters: list  The target bit list

static __inline unsigned int GRBP__bitListMask (  int  bit  )  [static]

Constructs a bit mask with _bit. The justication (in this case left) is consistent with the bit lists internal usage. Returns: The constructed bit mask Parameters: bit  The bit number to set (0-31)

static __inline void GRBP__bitListMaskClear (  unsigned int *  masks, int  bit )  [static]

Clears the specified bit in an array of bit masks. The bit number must be within the array of the bit masks. No checking on the validity is performed. Parameters: masks  The target array masks bit  The bit number to clear

static __inline void GRBP__bitListMaskSet (  unsigned int *  masks, int  bit )  [static]

Sets the specified bit in an array of bit masks. The bit number must be within the array of the bit masks. No checking on the validity is performed. Parameters: masks  The target array masks bit  The bit number to set

static __inline unsigned int GRBP__bitListMasksMerge (  unsigned int *  merge, unsigned int *  active, int  nmasks )  [static]

Creates a list masks that are in merged but not in active. The list of active masks is returned as the OR of the two lists. This function allows one to get bits that are not already in active, while at the same time updating active to be the complete set of bits. Parameters: merge  The bits to be merges into active. It is returned as the set of bits not already in active active  The set of currently active bits nmasks  The number of masks to merge

void GRBP_bitListClearCount (  GRBP_bitList *  list, int  from, int  mbits )

Clears the mbits from a specified starting position from. Parameters: list  The bit list to clear from  The starting bit position mbits  The number of bits to clear

unsigned char* GRBP_bitListConstruct (  GRBP_bitList *  list, int  max )

Constructs (initializes) the list of max elements. Returns: Pointer to the next available memory Parameters: list  The list to construct max  The maximum number of elements being maintained

int GRBP_bitListSizeof (  int  max  )

Computes the amount of memory to maintain a list of max elements. Returns: The size, in bytes, of the amount of memory to maintain a list of max elements Parameters: max  The maximum number of elements to maintain

---