---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > CMX / V2-10-0

Constituent: cmx_interface     Tag: linux-gcc

---

         

---

CMX_interface_prv.h File Reference

Private include file for the CMX component which deals with interfaces. More...

#include "CMX/CMX_interface_pub.h"

Include dependency graph for CMX_interface_prv.h:

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

Data Structures
struct	_CMX_Symbol
	Node in single linked list of symbols. More...
struct	_CMX_Instance
	An instance in an interface description (a single 'block' in the file). More...
struct	_CMX_Hierarchy
	Node in the hierarchical representation of the instances. More...
struct	_CMX_Interface
	Complete interface description of a constituent. More...
Typedefs
typedef unsigned int(*	CMX_cb_InterfaceRecurse )(void *user, struct _CMX_Hierarchy *hier, unsigned int depth)
	Typedef for a CMX interface hierarchy recursion callback routine.
Functions
signed int	CMX_interfaceCollate (struct _CMX_Instance *inst, struct _CMX_Instance *jnst)
	Collate two instance names.
unsigned int	CMX_interfaceRecurse (CMX_cb_InterfaceRecurse call, void *user, struct _CMX_Hierarchy *hier)
	Traverse (depth first) a CMX interface definition tree.

---

Detailed Description

Private include file for the CMX component which deals with interfaces.

CVS $Id: CMX_interface_prv.h,v 1.4 2007/09/21 23:38:27 kiml Exp $

---

Typedef Documentation

unsigned int CMX_cb_InterfaceRecurse

Typedef for a CMX interface hierarchy recursion callback routine. Parameters: user  User's parameter hier  Node in the hierarchy tree depth  Recursion depth This defines the signature of a CMX callback function. The callback is called for each node in the hierarchy tree of interfaces defined in a .cid file, starting at a node chosen by the caller in the primary call to the CMX_interfaceRecurse() routine.

---

Function Documentation

signed int CMX_interfaceCollate (  struct _CMX_Instance *  inst, struct _CMX_Instance *  jnst )

Collate two instance names. Parameters: inst  First instance jnst  Second instance CMX_interfaceCollate() implements a collation order for interface instance names. The order is alphabetic by stem name, then increasing by major, minor and patch number. Return values: -4  inst < jnst (based on alpabetic ordering) -3  inst < jnst (based on major version ordering) -2  inst < jnst (based on minor version ordering) -1  inst < jnst (based on patch version ordering) 0  inst = jnst 1  inst > jnst (based on patch version ordering) 2  inst > jnst (based on minor version ordering) 3  inst > jnst (based on major version ordering) 4  inst > jnst (based on alpabetic ordering)

unsigned int CMX_interfaceRecurse (  CMX_cb_InterfaceRecurse  call, void *  user, struct _CMX_Hierarchy *  hier )

Traverse (depth first) a CMX interface definition tree. Parameters: call  User's callback routine (called for each node) user  User's callback parameter hier  Starting node in the hierarchy tree Return values: 0  Hierarchy traversed successfully x  Error return from the user callback routine

---