LSM_prvdefs.h File Reference

Private definitions for the LSM package. More...

#include <LSM_DB/LSM_DB_schema.h>
#include <ATT/ATT.h>
#include <ITC/ITC_pubdefs.h>
#include <IMM/RBM_pubdefs.h>
#include <PBS/RW.ih>
#include <PBS/MTX.h>
#include <PBS/FPA.h>

Classes
struct	_LSM_Control
	Structure to hold the LSM control block. More...
Defines
#define	LSM_SIATTITUDE_PKT_SIZE   60
#define	LSM_SIANCILLARY_PKT_SIZE   44
#define	LSM_SITIMETONE_PKT_SIZE   14
Typedefs
typedef enum _LSM_ControlState	LSM_ControlState
	Typedef for enum _LSM_ControlState.
typedef struct _LSM_Control	LSM_Control
	Typedef for struct _LSM_Control.
Enumerations
enum	_LSM_ControlState {   LSM_CTL_UNKNOWN = -1,   LSM_CTL_UNINITIALIZED = 0,   LSM_CTL_INITIALIZED = 1,   LSM_CTL_STARTED = 2 }
	Enumeration of LSM control states. More...
Functions
unsigned int	LSM_broadcastToEpuCmd (void *pay, unsigned int len)
unsigned int	LSM_getSsrOut (int payloadSize, int lsfTypeid, int lsfVersion, void **qitemPtr, int *qitemLen, void **payloadPtr)
	Alloc and fill packet for SSR except for payload.
unsigned int	LSM_sendSsrOut (void *qItem, int totalLen)
	Send out filled-in packet to the SSR.

---

Detailed Description

Private definitions for the LSM package.

CVS $Id: LSM_prvdefs.h,v 1.13 2011/03/29 21:44:12 russell Exp $

Author:

A.P.Waite

---

Define Documentation

#define LSM_SIANCILLARY_PKT_SIZE   44

The size in bytes of the SC ancillary packets.

#define LSM_SIATTITUDE_PKT_SIZE   60

The size in bytes of the SC attitude packets.

#define LSM_SITIMETONE_PKT_SIZE   14

The size in bytes of the SC timetone packets.

---

Enumeration Type Documentation

enum _LSM_ControlState

Enumeration of LSM control states.

Enumerator:

LSM_CTL_UNKNOWN	Unknown (guard value)
LSM_CTL_UNINITIALIZED	Uninitialized
LSM_CTL_INITIALIZED	Initialized
LSM_CTL_STARTED	Started

---

Function Documentation

unsigned int LSM_getSsrOut	(	int	payloadSize,
		int	lsfTypeid,
		int	lsfVersion,
		void **	qitemPtr,
		int *	qitemLen,
		void **	payloadPtr
	)

Alloc and fill packet for SSR except for payload.

Parameters:

	payloadSize	size of payload to be filled in
	lsfTypeid	Typeid for the LSF header
	lsfVersion	Version for LSF record
	qitemPtr	returns pointer to the entire ITC buffer
	qitemLen	length of while ITC buffer
	payloadPtr	pointer into packet to put payload

Returns:

status

References LSM_LSF_DATAGRAM_VER, LSM_MAGIC7_TLM_APID, and _LSM_Control::ssrOutBuff.

Referenced by LSM_SIANCILLARY(), LSM_SIATTITUDE(), and LSM_SITIMETONE().

unsigned int LSM_sendSsrOut	(	void *	qItem,
		int	totalLen
	)

Send out filled-in packet to the SSR.

Parameters:

	qItem	pointer to the qItem
	totalLen	length of the qItem

Returns:

status

References _LSM_Control::ssrOutBuff.

Referenced by LSM_SIANCILLARY(), LSM_SIATTITUDE(), and LSM_SITIMETONE().