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

Constituent: qmem_unit_test     Tag: linux-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » QSD » source » QMEM » V0-2-0 » ptd

qmem_unit_test.h File Reference

Interface to the test utility functions found in qmem_unit_test.c. More...

#include "QMEM/QMEM.h"

Include dependency graph for qmem_unit_test.h:

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


Data Structures

struct  _test_Test_Descriptor
 Description of a test state. More...
struct  _Context
 QMEM context information. More...

Defines

#define DIM(a)   (sizeof (a) / sizeof ((a)[0]))
 Dimension of an array.

Typedefs

typedef _test_Test_Descriptor test_Test_Descriptor
 Typedef for _test_Test_Descriptor.
typedef _Context Context
 Typedef for _Context.

Functions

void test_Push_State (test_Test_Descriptor *td_p, const char *desc, const int index)
 Enter a new test state.
void test_Pop_State (test_Test_Descriptor *td_p)
 Return for a test state.
void test_Show (const test_Test_Descriptor *td_p, const int level, const char *item_1, const char *item_2)
 Display text with indentation.
int test_Generic_Error (const test_Test_Descriptor *td_p, const char *fmt, const char *str_param, const unsigned int int_param)
 Display a generic error message.
int test_Context_Compare (const test_Test_Descriptor *td_p, const Context *expect_p, const Context *actual_p, const char *desc)
 Verify parsing context information.
int test_Memory_Compare (const test_Test_Descriptor *td_p, const void *expect_p, const void *actual_p, const void *mask_p, const unsigned int num_bytes)
 Verify the contents of a buffer in memory.
int test_NULL_Compare (const test_Test_Descriptor *td_p, const unsigned int actual, const char *desc)
 Check a 32-bit value to make sure it is not NULL.
int test_Status_Compare (const test_Test_Descriptor *td_p, const QMEM_Status expect, const QMEM_Status actual, const char *func)
 Check a QMEM_Status value.
int test_Value32_Compare (const test_Test_Descriptor *td_p, const unsigned int expect, const unsigned int actual, const char *desc)
 Check a 32-bit value.
void test_Show_Item (const test_Test_Descriptor *td_p, const char *name, const char *fmt, const char *str_param, const unsigned int int_param)
 Display an item of data.
void qmem_test_context (test_Test_Descriptor *td_p, const unsigned int bit_mask)
 Unit test for the QMEM context information functions.
void qmem_test_ctb (test_Test_Descriptor *td_p, const unsigned int bit_mask)
 Unit test for the QMEM_parse_contribution() function.
void qmem_test_datagram (test_Test_Descriptor *td_p, const unsigned int bit_mask)
 Unit test for the QMEM_parse_datagram() function.
void qmem_test_start (test_Test_Descriptor *td_p, const unsigned int bit_mask)
 Unit test for the QMEM_start_parsing() function.

Detailed Description

Interface to the test utility functions found in qmem_unit_test.c. 

**  CVS $Id: qmem_unit_test.h,v 1.1.1.1 2005/12/13 21:46:07 dmay Exp $
**

Function Documentation

void qmem_test_context (  test_Test_Descriptor *  td_p,
const unsigned int  bit_mask
) 
 

Unit test for the QMEM context information functions.

Parameters:
td_p Pointer to test descriptor.
bit_mask Bitmask ID for this subtest.
Returns:
Nothing.

void qmem_test_ctb (  test_Test_Descriptor *  td_p,
const unsigned int  bit_mask
) 
 

Unit test for the QMEM_parse_contribution() function.

Parameters:
td_p Pointer to test descriptor.
bit_mask Bitmask ID for this subtest.
Returns:
Nothing.

void qmem_test_datagram (  test_Test_Descriptor *  td_p,
const unsigned int  bit_mask
) 
 

Unit test for the QMEM_parse_datagram() function.

Parameters:
td_p Pointer to test descriptor.
bit_mask Bitmask ID for this subtest.
Returns:
Nothing.

void qmem_test_start (  test_Test_Descriptor *  td_p,
const unsigned int  bit_mask
) 
 

Unit test for the QMEM_start_parsing() function.

Parameters:
td_p Pointer to test descriptor.
bit_mask Bitmask ID for this subtest.
Returns:
Nothing.

int test_Context_Compare (  const test_Test_Descriptor *  td_p,
const Context *  exp_p,
const Context *  act_p,
const char *  desc
) 
 

Verify parsing context information.

Parameters:
td_p Pointer to test descriptor.
exp_p Pointer to expected information.
act_p Pointer to actual information.
desc Description of the information.
Return values:
0 Information is correct.
-1 Information is not correct.

int test_Generic_Error (  const test_Test_Descriptor *  td_p,
const char *  fmt,
const char *  str_param,
const unsigned int  int_param
) 
 

Display a generic error message.

Parameters:
td_p Pointer to test descriptor.
fmt Format string to display.
str_param First parameter (string) for fmt string.
int_param Second parameter (uint) for fmt string.
Returns:
-1.

int test_Memory_Compare (  const test_Test_Descriptor *  td_p,
const void *  expect_p,
const void *  actual_p,
const void *  mask_p,
const unsigned int  num_bytes
) 
 

Verify the contents of a buffer in memory.

This function verifies the contents of a memory buffer and reports an error if the values are not as expected. An optional mask can be used to indicate which bits should be verified.

Parameters:
td_p Pointer to test descriptor.
expect_p Pointer to a memory buffer with the expected values.
actual_p Pointer to the memory buffer to verify.
mask_p Pointer to a memory buffer of mask values.
num_bytes Number of bytes to verify within the buffer.
Return values:
0 Buffer values are correct.
-1 One or more values within the buffer are incorrect.

int test_NULL_Compare (  const test_Test_Descriptor *  td_p,
const unsigned int  actual,
const char *  desc
) 
 

Check a 32-bit value to make sure it is not NULL.

Parameters:
td_p Pointer to test descriptor.
actual Actual value.
desc Description of the value.
Return values:
0 Actual value != NULL.
-1 Actual value == NULL.

void test_Pop_State (  test_Test_Descriptor *  td_p  ) 
 

Return for a test state.

Pop a test state description from a test's state stack.

Parameters:
td_p Pointer to test descriptor.
Returns:
Nothing.

void test_Push_State (  test_Test_Descriptor *  td_p,
const char *  desc,
const int  index
) 
 

Enter a new test state.

Push a new test state description onto a test's state stack. This state stack provides a trace of the execution of the test.

Parameters:
td_p Pointer to test descriptor.
desc Description of the new state.
index Generic index value.
Returns:
Nothing.

void test_Show (  const test_Test_Descriptor *  td_p,
const int  level,
const char *  item_1,
const char *  item_2
) 
 

Display text with indentation.

Display text with indentation appropriate for the specified level.

Parameters:
td_p Pointer to test descriptor.
level Indentation level.
item_1 First text string to display.
item_2 Second text string to display.
Returns:
Nothing.

void test_Show_Item (  const test_Test_Descriptor *  td_p,
const char *  name,
const char *  fmt,
const char *  str_param,
const unsigned int  int_param
) 
 

Display an item of data.

This function displays an item of data in a predefined format.

Parameters:
td_p Pointer to test descriptor.
name Name of the item.
fmt Format string to display the item's value.
str_param First parameter (string) for fmt string.
int_param Second parameter (uint) for fmt string.
Returns:
Nothing.

int test_Status_Compare (  const test_Test_Descriptor *  td_p,
const QMEM_Status  expect,
const QMEM_Status  actual,
const char *  func
) 
 

Check a QMEM_Status value.

Compare actual and expected QMEM_Status values and display a message if they differ.

Parameters:
td_p Pointer to test descriptor.
expect Expected value.
actual Actual value.
func Name of the function that returned the status.
Return values:
0 Actual value == Expected value
-1 Actual value != Expected value.

int test_Value32_Compare (  const test_Test_Descriptor *  td_p,
const unsigned int  expect,
const unsigned int  actual,
const char *  desc
) 
 

Check a 32-bit value.

Compare actual and expected 32-bit values and display a message if they differ.

Parameters:
td_p Pointer to test descriptor.
expect Expected value.
actual Actual value.
desc Description of the value.
Return values:
0 Actual value == Expected value
-1 Actual value != Expected value.

Generated on Sun Jun 14 02:18:45 2009 by  doxygen 1.4.4