---

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

Constituent: rim     Tag: linux-gcc

---

         

---

map_p.h File Reference

Definition of the RIM_map structure and associated internal functions. More...

#include "RIM/map.h"
#include "AG_rimType_p.h"
#include <stddef.h>

Include dependency graph for map_p.h:

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

Data Structures
struct	RIM_map_
	Structure that acts as a bit-map of all the LAT components. More...
Defines
#define	MAX_MAP   ( (N_MAX/32) + 1 )
	Number of 32 bit words guarenteed to be big enough to hold a map large enough for any component type.
Functions
unsigned	mapIndex (const RIM_map *map, RIM_type type, const RIM_addr *addr, unsigned *index)
	Convert the address into an index appropriate for this type of map as well as performing various checks on the input parameters.
unsigned	mapRange (const RIM_map *map, RIM_type type, unsigned twr, unsigned *start, unsigned *end)
	Find start and end indicies to use in a loop over all the bits in one tower (ie the first bit of the tower and the bit one past the last bit of the same tower).

---

Detailed Description

Definition of the RIM_map structure and associated internal functions.

Author:

James Swain -- jswain@slac.stanford.edu

---

Function Documentation

unsigned mapIndex (  const RIM_map *  map, RIM_type  type, const RIM_addr *  addr, unsigned *  index )

Convert the address into an index appropriate for this type of map as well as performing various checks on the input parameters. Parameters: map  Pointer to a map structure type  Type of the map addr  Pointer to an address structure identifying the required bit index  Pointer to location to store the calculated index Return values: RIM_TYPE_UK  if the type does not exist RIM_MAP_NONE  if there is no sub-map corresponding to this type RIM_ADDR_BCAST  if the address contains a mixture of broadcast and singlecast addresses RIM_ADDR_RANGE  if any component of the address is out of range RIM_ADDR_INDEX  if the final index exceeds the total number of bits in the map RIM_SUCCESS  if everything goes well

unsigned mapRange (  const RIM_map *  map, RIM_type  type, unsigned  twr, unsigned *  start, unsigned *  end )

Find start and end indicies to use in a loop over all the bits in one tower (ie the first bit of the tower and the bit one past the last bit of the same tower). Parameters: map  Pointer to a map structure type  Type of the map twr  Tower ID start  Pointer to location to store the index of the start bit end  Pointer to location to store the index of the end bit Return values: RIM_TYPE_UK  if the type does not exist RIM_MAP_NONE  if there is no sub-map corresponding to this type RIM_ADDR_BCAST  if the address contains a mixture of broadcast and singlecast addresses RIM_ADDR_RANGE  if any component of the address is out of range RIM_ADDR_INDEX  if the final index exceeds the total number of bits in the map RIM_SUCCESS  if everything goes well

---