---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LSF / V2-0-2

Constituent: document_lsf     Tag: rad750

---

         

---

LSF_reason.h File Reference

What you have all been looking for the reason why things happen, at least why LSF event datagrams are opened and closed. More...

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

Typedefs
typedef enum _LSF_REASON_K	LSF_REASON_K
	Typedef for enum LSF_REASON_K.
typedef enum _LSF_REASON_OPEN_K	LSF_REASON_OPEN_K
	Typedef for LSF_REASON_OPEN_K.
typedef enum _LSF_REASON_OPEN_K	LSF_reason_open
	Typedef for LSF_REASON_OPEN_K.
typedef enum _LSF_REASON_CLOSE_K	LSF_REASON_CLOSE_K
	Typedef for LSF_REASON_CLOSE_K.
typedef enum _LSF_REASON_CLOSE_K	LSF_reason_close
	Typedef for LSF_REASON_CLOSE_K.
Enumerations
enum	_LSF_REASON_K {   LSF_REASON_K_AUTO = 0xb,   LSF_REASON_K_AUTO_MODE = 0xc,   LSF_REASON_K_AUTO_TIME = 0xd,   LSF_REASON_K_AUTO_COUNT = 0xe,   LSF_REASON_K_AUTO_FULL = 0xf }
	These are the autonomous reasons that are common to both the open and close reasons. More...
enum	_LSF_REASON_OPEN_K {   LSF_REASON_OPEN_K_START = 0x0,   LSF_REASON_OPEN_K_START_OP = 0x1,   LSF_REASON_OPEN_K_START_AUTO = 0x2,   LSF_REASON_OPEN_K_START_3 = 0x3,   LSF_REASON_OPEN_K_RSVD_4 = 0x4,   LSF_REASON_OPEN_K_RSVD_5 = 0x5,   LSF_REASON_OPEN_K_RSVD_6 = 0x6,   LSF_REASON_OPEN_K_RSVD_7 = 0x7,   LSF_REASON_OPEN_K_RESUME = 0x8,   LSF_REASON_OPEN_K_RESUME_OP = 0x9,   LSF_REASON_OPEN_K_RESUME_AUTO = 0xa,   LSF_REASON_OPEN_K_AUTO = LSF_REASON_K_AUTO,   LSF_REASON_OPEN_K_AUTO_MODE = LSF_REASON_K_AUTO_MODE,   LSF_REASON_OPEN_K_AUTO_TIME = LSF_REASON_K_AUTO_TIME,   LSF_REASON_OPEN_K_AUTO_COUNT = LSF_REASON_K_AUTO_COUNT,   LSF_REASON_OPEN_K_AUTO_FULL = LSF_REASON_K_AUTO_FULL }
	Enumerates the reason why a event datagram has been opened. More...
enum	_LSF_REASON_CLOSE_K {   LSF_REASON_CLOSE_K_STOP = 0x0,   LSF_REASON_CLOSE_K_STOP_OP = 0x1,   LSF_REASON_CLOSE_K_STOP_TIME = 0x2,   LSF_REASON_CLOSE_K_STOP_COUNT = 0x3,   LSF_REASON_CLOSE_K_ABORT = 0x4,   LSF_REASON_CLOSE_K_ABORT_OP = 0x5,   LSF_REASON_CLOSE_K_ABORT_AUTO = 0x6,   LSF_REASON_CLOSE_K_RSVD_7 = 0x7,   LSF_REASON_CLOSE_K_PAUSE = 0x8,   LSF_REASON_CLOSE_K_PAUSE_OP = 0x9,   LSF_REASON_CLOSE_K_PAUSE_AUTO = 0xA,   LSF_REASON_CLOSE_K_AUTO = LSF_REASON_K_AUTO,   LSF_REASON_CLOSE_K_AUTO_MODE = LSF_REASON_K_AUTO_MODE,   LSF_REASON_CLOSE_K_AUTO_TIME = LSF_REASON_K_AUTO_TIME,   LSF_REASON_CLOSE_K_AUTO_COUNT = LSF_REASON_K_AUTO_COUNT,   LSF_REASON_CLOSE_K_AUTO_FULL = LSF_REASON_K_AUTO_FULL }
	Enumerates the reasons why an event datagram has been closed. More...

---

Detailed Description

What you have all been looking for the reason why things happen, at least why LSF event datagrams are opened and closed.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: LSF_reason.h,v 1.2 2005/11/17 20:53:18 russell Exp $

This enumeration is a bit of conglomeration, combining the action (START/PAUSE/RESUME/STOP) with a reason (OPERARTOR COMMAND, AUTOMATIC SOFTWARE ACTION). Because this is value appears in the transport layer, the representation had to be compact. Placing the action and the reason in two different enumerations, while more elegant, would have cost more bits.

---

Typedef Documentation

LSF_reason_close

Typedef for LSF_REASON_CLOSE_K. This enumerates the reasons why an event datagram has been closed. If bit 3 is set, one should expect that another packet in with the same ground/run identifier will follow. Conversely if bit 3 is cleared, no more packets with the same ground/run identifier will follow.

LSF_REASON_K

Typedef for enum LSF_REASON_K. These definitions are common to both the open and close reasons and are nevered specified directly by the user; use the equivalent LSF_REASON_OPEN_K or LSF_REASON_CLOSE_K definitions.

LSF_reason_open

Typedef for LSF_REASON_OPEN_K. This enumerates the reasons why an event datagram has been opened. If bit 3 is set, one should expect that the previous packet had the same ground/run identifier. Conversely if bit 3 is cleared, this is the first with this ground/run identifier.

---

Enumeration Type Documentation

enum _LSF_REASON_CLOSE_K

Enumerates the reasons why an event datagram has been closed. Enumerator: LSF_REASON_CLOSE_K_STOP  Stop, unspecified reason LSF_REASON_CLOSE_K_STOP_OP  By operator generated command LSF_REASON_CLOSE_K_STOP_TIME  Time limit reached LSF_REASON_CLOSE_K_STOP_COUNT  Count limit reached LSF_REASON_CLOSE_K_ABORT  Unspecified reason LSF_REASON_CLOSE_K_ABORT_OP  By operator generated command LSF_REASON_CLOSE_K_ABORT_AUTO  By software generated command LSF_REASON_CLOSE_K_RSVD_7  Reserved for future use LSF_REASON_CLOSE_K_PAUSE  Unspecified reason LSF_REASON_CLOSE_K_PAUSE_OP  By operator generated command LSF_REASON_CLOSE_K_PAUSE_AUTO  By software generated command LSF_REASON_CLOSE_K_AUTO  Packet is being closed for unspecified reason LSF_REASON_CLOSE_K_AUTO_MODE  Packet is being closed due to a mode change LSF_REASON_CLOSE_K_AUTO_TIME  Packet is being closed because the time limit has been reached LSF_REASON_CLOSE_K_AUTO_COUNT  Packet is being closed because the count limit has been reached LSF_REASON_CLOSE_K_AUTO_FULL  Packet is being closed because there is no more room

enum _LSF_REASON_K

These are the autonomous reasons that are common to both the open and close reasons. Enumerator: LSF_REASON_K_AUTO  Packet is continuing LSF_REASON_K_AUTO_MODE  Mode change encountered LSF_REASON_K_AUTO_TIME  Packet time limit reached LSF_REASON_K_AUTO_COUNT  Packet count limit reached LSF_REASON_K_AUTO_FULL  Packet full

enum _LSF_REASON_OPEN_K

Enumerates the reason why a event datagram has been opened. Enumerator: LSF_REASON_OPEN_K_START  Start, unspecified reason LSF_REASON_OPEN_K_START_OP  By operator generated command LSF_REASON_OPEN_K_START_AUTO  By software generated command LSF_REASON_OPEN_K_START_3  Reserved for future use LSF_REASON_OPEN_K_RSVD_4  Reserved for future use LSF_REASON_OPEN_K_RSVD_5  Reserved for future use LSF_REASON_OPEN_K_RSVD_6  Reserved for future use LSF_REASON_OPEN_K_RSVD_7  Reserved for future use LSF_REASON_OPEN_K_RESUME  Unspecified reason LSF_REASON_OPEN_K_RESUME_OP  By operator command LSF_REASON_OPEN_K_RESUME_AUTO  By autonomous request LSF_REASON_OPEN_K_AUTO  Continuing after previous packet filled for unspecified reason LSF_REASON_OPEN_K_AUTO_MODE  Continuing with a new mode LSF_REASON_OPEN_K_AUTO_TIME  Continuing after previous packet reached time limit LSF_REASON_OPEN_K_AUTO_COUNT  Continuing afer Previous packet reached count limit LSF_REASON_OPEN_K_AUTO_FULL  Continuing after previous packet filled, no more room

---