---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LCM / V1-4-3

Constituent: lcm_siu     Tag: rad750

---

         

---

LCM_pubdefs.h File Reference

Public definitions for the LCM package. More...

#include "LSF/LSF.h"
#include "LCM/LCM_tlmdefs.h"
#include "PBS/WCT.h"

Include dependency graph for LCM_pubdefs.h:

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

Data Structures
struct	_LCM_MSG_Dump_Info
	MSG dump information version 1 (current definition). More...
struct	_LCM_MSG_Dump_Datagram
	LCM datagram for MSG output. More...
Defines
#define	LCM_MSG_VERSION_DGM   (2)
	Current version of the LCM package MSG output SSR datagram format.
#define	LCM_MSG_VERSION_INFO   (1)
	Current version of the LCM package MSG output information format.
#define	LCM_MSG_VERSION_TEXT   (1)
	Current version of the LCM package MSG output text format.
Typedefs
typedef enum _LCM_MSG_Id	LCM_MSG_Id
	Typedef for _LCM_MSG_Id.
typedef _LCM_MSG_Dump_Info	LCM_MSG_Dump_Info
	Typedef for _LCM_MSG_Dump_Info.
typedef _LCM_MSG_Dump_Datagram	LCM_MSG_Dump_Datagram
	Typedef for _QLFS_Dump_Datagram.
Enumerations
enum	_LCM_MSG_Id {   LCM_MSG_ID_NONE = 0,   LCM_MSG_ID_INFO = 1,   LCM_MSG_ID_TEXT = 2 }
	LCM package MSG output contribution IDs. More...
Functions
unsigned int	LCM_countsGet (unsigned short *buf)
	Get error counter values.
unsigned int	LCM_countsSizeof (void)
	Get error counter size.
unsigned int	LCM_initialize (void)
	Initialize the LCM system.
void	LCM_msgAttachCTDB (void)
	Setup MSG output callback for CTDB diagnostic telemetry.
void	LCM_msgAttachSSR (void)
	Setup MSG output callback for SSR science data telemetry.
unsigned int	LCM_reportOnce (void)
	Report the module/task state (once only, at end of SBC).
unsigned int	LCM_shutdown (void)
	Shut down the LCM system.
unsigned int	LCM_start (void)
	Start the LCM task.
unsigned int	LCM_stop (void)
	Stop the LCM task.

---

Detailed Description

Public definitions for the LCM package.

CVS $Id: LCM_pubdefs.h,v 1.8 2007/10/29 00:29:03 apw Exp $

Author:

A.P.Waite

---

Enumeration Type Documentation

enum _LCM_MSG_Id

LCM package MSG output contribution IDs. Enumerator: LCM_MSG_ID_NONE  Reserved ID value. LCM_MSG_ID_INFO  MSG information contribution. LCM_MSG_ID_TEXT  MSG text string contribution.

---

Function Documentation

unsigned int LCM_countsGet (  unsigned short *  buf  )

Get error counter values. Read LCM LCP error counter values. Parameters: buf  The buffer to write the counts to.

unsigned int LCM_countsSizeof (  void   )

Get error counter size. Get the size needed to read the LCM LCP error counter values. Returns: The size in bytes of the buffer needed for LCM_countsGet().

unsigned int LCM_initialize (  void   )

Initialize the LCM system. Return values: LCM_ALOCFAIL  Memory allocation failure LCM_BADSTAT  Not in state "uninitialized" (bad state transition) LCM_MUALOCFL  Cannot allocate a mutex LCM_SUCCESS  Success LCM_initialize() initializes the LAT Spacecraft Messages system.

void LCM_msgAttachCTDB (  void   )

Setup MSG output callback for CTDB diagnostic telemetry. Attach LCM CTDB output callback.

void LCM_msgAttachSSR (  void   )

Setup MSG output callback for SSR science data telemetry. Attach LCM SSR science data output callback.

unsigned int LCM_reportOnce (  void   )

Report the module/task state (once only, at end of SBC). Return values: LCM_ALOCFAIL  Memory allocation failure LCM_BADSTAT  Not in state "uninitialized" (bad state transition) LCM_SUCCESS  Success LCM_reportOnce() provides the facility to do a one time dump of the module list and the task list at the conclusion of secondary boot.

unsigned int LCM_shutdown (  void   )

Shut down the LCM system. Return values: LCM_SUCCESS  Success LCM_shutdown() shuts down the LAT Spacecraft Messages system.

unsigned int LCM_start (  void   )

Start the LCM task. LCM_start() starts the LCM task. The LCM control state should be LCM_CTL_INITIALIZED before calling this function. On successful exit from this function, the LCM control state will be LCM_CTL_STARTING. As part of LCM's task start procedures, the LCM task first runs a one-time task initialization routine in LCM task context. If that is successful, the LCM control state is changed to LCM_CTL_RUNNING. Any failures along the way and the LCM control state is set to LCM_CTL_BROKEN.

unsigned int LCM_stop (  void   )

Stop the LCM task. The LCM control state should be LCM_CTL_RUNNING before calling this function (after calling LCM_start()). Sets LCM control state to LCM_CTL_INITIALIZED. This function is a replacement for LCM_stopTask(). Returns: A FILE MSG code.

---