---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > ITC / V2-1-7

Constituent: itc     Tag: rad750

---

         

---

ITC_utility.c File Reference

Collection of utility routines. More...

#include <string.h>
#include "MSG/MSG_pubdefs.h"
#include "ITC/ITC_msgs.h"
#include "ITC_prvdefs.h"

Include dependency graph for ITC_utility.c:

Functions
unsigned int	ITC_copyCounts (void *dst, ITC_TaskID tid)
	Copy a command counts block to the provided destination.
ITC_NodeID	ITC_getPacketDstNodeID (const struct _ITC_QueueItem *qitem)
	Return destination node ID for given queue item.
ITC_QueueID	ITC_getPacketDstQueueID (const struct _ITC_QueueItem *qitem)
	Return destination queue ID for given queue item.
ITC_TaskID	ITC_getPacketDstTaskID (const struct _ITC_QueueItem *qitem)
	Return destination task ID for given queue item.
void *	ITC_getPacketPay (const struct _ITC_QueueItem *qitem)
	Return pointer to packet payload for queue item.
ITC_ProtID	ITC_getPacketProtocol (const struct _ITC_QueueItem *qitem)
	Return ITC protocol for given queue item.
ITC_NodeID	ITC_getPacketSrcNodeID (const struct _ITC_QueueItem *qitem)
	Return source node ID for given queue item.
ITC_TaskID	ITC_getPacketSrcTaskID (const struct _ITC_QueueItem *qitem)
	Return source task ID for given queue item.
ITC_QueueID	ITC_getQueueID (struct _ITC_Queue *queue)
	Return queue ID for given queue.
unsigned int	ITC_sizeofCounts ()
	Return size of a command counting structure.

---

Detailed Description

Collection of utility routines.

CVS $Id: ITC_utility.c,v 1.6 2004/11/30 23:14:17 apw Exp $

Author:

A.P.Waite

---

Function Documentation

unsigned int ITC_copyCounts (  void *  dst, ITC_TaskID  tid )

Copy a command counts block to the provided destination. Parameters: dst  (in) Destination of copy tid  (in) Task for which to copy counts

ITC_NodeID ITC_getPacketDstNodeID (  const struct _ITC_QueueItem *  qitem  )

Return destination node ID for given queue item. Parameters: qitem  (in) Queue item pointer Return values: x  Node ID (ITC_NID_UNKNOWN on error)

ITC_QueueID ITC_getPacketDstQueueID (  const struct _ITC_QueueItem *  qitem  )

Return destination queue ID for given queue item. Parameters: qitem  (in) Queue item pointer Return values: x  Queue ID (ITC_QID_UNKNOWN on error)

ITC_TaskID ITC_getPacketDstTaskID (  const struct _ITC_QueueItem *  qitem  )

Return destination task ID for given queue item. Parameters: qitem  (in) Queue item pointer Return values: x  Task ID (ITC_TID_UNKNOWN on error)

void* ITC_getPacketPay (  const struct _ITC_QueueItem *  qitem  )

Return pointer to packet payload for queue item. Parameters: qitem  (in) Queue item Return values: NULL  Queue item is NULL x  Pointer to packet payload

ITC_ProtID ITC_getPacketProtocol (  const struct _ITC_QueueItem *  qitem  )

Return ITC protocol for given queue item. Parameters: qitem  (in) Queue item pointer Return values: x  Task ID (ITC_PRT_UNKNOWN on error)

ITC_NodeID ITC_getPacketSrcNodeID (  const struct _ITC_QueueItem *  qitem  )

Return source node ID for given queue item. Parameters: qitem  (in) Queue item pointer Return values: x  Node ID (ITC_NID_UNKNOWN on error)

ITC_TaskID ITC_getPacketSrcTaskID (  const struct _ITC_QueueItem *  qitem  )

Return source task ID for given queue item. Parameters: qitem  (in) Queue item pointer Return values: x  Task ID (ITC_TID_UNKNOWN on error)

ITC_QueueID ITC_getQueueID (  struct _ITC_Queue *  queue  )

Return queue ID for given queue. Parameters: queue  (in) Queue pointer Return values: x  Queue ID (ITC_L_QUEUES on error)

unsigned int ITC_sizeofCounts (  void   )

Return size of a command counting structure. Return values: Size  of command counting structure

---