GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LATC / dev > latc_cmn / rhel4-32


Interface   Data Structures   File List   Data Fields   Globals  

imm.h File Reference

LATC in-memory-model structure. More...

#include <map.h>
#include <LEM/list_structs.h>
#include <AG_initIMM_p.h>

Defines

#define CHECK_TYPE(t_)
 Check that the type is valid.
#define CHECK_IDS(t_, r_, f_)
 Check that the reg ID and fld ID are consistent with the type.

Functions

LATC_imm * LATC_newIMM (void)
 Allocates and initialises a new in-memory-model structure.
void LATC_deleteIMM (LATC_imm *imm)
 Frees the allocated memory associated with the LATC structure.
void LATC_clearIMM (LATC_imm *imm)
 Clear out the map and data portions of the IMM structure.


Detailed Description

LATC in-memory-model structure.

Author:
James Swain -- jswain@slac.stanford.edu

Define Documentation

#define CHECK_IDS ( t_,
r_,
f_   ) 

Value:

{ \
  if(r_ >= ld[t_]->nregs)        return _msg_report(LATC_BADREG,   0, 2, r_, ld[t_]->nregs); \
  if(f_ >= ld[t_]->rd[r_].nflds) return _msg_report(LATC_BADFIELD, 0, 2, f_, ld[t_]->rd[r_].nflds); \
}
Check that the reg ID and fld ID are consistent with the type.

Referenced by LATC_get(), and LATC_set().

#define CHECK_TYPE ( t_   ) 

Value:

{ \
  if(N_LATC_TYPES <= t_) return _msg_report(LATC_BADTYPE,  0, 1, t_); \
  if(!ld[t_])            return _msg_report(LATC_NOCPT,    0, 1, t_); \
}
Check that the type is valid.

Referenced by LATC_deleteData(), LATC_get(), and LATC_set().


Function Documentation

void LATC_clearIMM ( LATC_imm *  imm  ) 

Clear out the map and data portions of the IMM structure.

Parameters:
imm Pointer to the IMM structure to clear

References LATC_clearMap(), and LATC_setReg().

void LATC_deleteIMM ( LATC_imm *  imm  ) 

Frees the allocated memory associated with the LATC structure.

Parameters:
imm Pointer to an IMM structure created using LATC_newIMM()

References LATC_deleteMap().

LATC_imm* LATC_newIMM ( void   ) 

Allocates and initialises a new in-memory-model structure.

Returns:
Pointer to an intialised LATC

References align(), LATC_newMap(), LATC_setReg(), roundUp(), and sizeofCpt().


Generated on Thu Apr 7 17:31:28 2011 by  doxygen 1.5.8