arraytemplate.h

#ifndef arraytemplate_h
#define arraytemplate_h

// This file defines the templates required by new_ArrayMap() for
// creating array maps. The resulting register map, and accompanying
// objects are defined in arraymap.h.

#include "arraymap.h"
#include "regtemplate.h"

// Uncomment the following for debugging information
// #define ARRAYMAP

typedef struct {
  char name[REG_NAME_LEN+1]; // An unambiguous name for the template
  RegTemplate* regtemplate;  // The template of registers
  char comment_[100];
} RegTemp;

typedef struct {
  RegTemp *templates;  // The array of register templates 
  unsigned ntemplate;  // The number of elements in templates[]
} ArrayTemplate;

ArrayMap *new_ArrayMap(ArrayTemplate *arrayTmp);

/*.......................................................................
 * Retreive an array map template from a network buffer and convert
 * it to an array map.
 */
ArrayMap *net_get_ArrayMap(gcp::control::NetBuf *net);

int net_put_ArrayTemplate(ArrayTemplate *arrTmp, gcp::control::NetBuf *net);

/*.......................................................................
 * Unpack an array map template from a network buffer.
 */
ArrayTemplate *net_get_ArrayTemplate(gcp::control::NetBuf *net);

/*.......................................................................
 * Return the space needed to pack a given array-map template
 * into a NetBuf network buffer.
 */
int net_ArrayTemplate_size(ArrayTemplate *arrayTmp);

ArrayTemplate *del_ArrayTemplate(ArrayTemplate *arrayTmp);

#endif