CCSDS_sequenceFlags.h File Reference

Maps out the CCSDS packet header sequence flags. More...

Typedefs
typedef enum _CCSDS_SEQUENCE_FLAGS_V	CCSDS_SEQUENCE_FLAGS_V
	Typedef for enum _CCSDS_SEQUENCE_FLAGS_V.
typedef enum _CCSDS_SEQUENCE_FLAGS_M	CCSDS_SEQUENCE_FLAGS_M
	Typedef for enum _CCSDS_SEQUENCE_FLAGS_M.
typedef enum _CCSDS_SEQUENCE_FLAGS_K	CCSDS_SEQUENCE_FLAGS_K
	Typedef for CCSDS_SEQUENCE_FLAGS_K.
Enumerations
enum	_CCSDS_SEQUENCE_FLAGS_V {   CCSDS_SEQUENCE_FLAGS_V_FIRST = 0,   CCSDS_SEQUENCE_FLAGS_V_LAST = 1 }
	The CCSDS sequence flags, right shift. This is really a 2 bit a value with bit 0 indicating whether this is the first CCSDS packet bit 1 indicating whether this is the last CCSDS packet. More...
enum	_CCSDS_SEQUENCE_FLAGS_M {   CCSDS_SEQUENCE_FLAGS_M_FIRST = 1 << CCSDS_SEQUENCE_FLAGS_V_FIRST,   CCSDS_SEQUENCE_FLAGS_M_LAST = 1 << CCSDS_SEQUENCE_FLAGS_V_LAST }
	The CCSDS sequence flags. This is really a 2 bit a value with bit 0 indicating whether this is the first CCSDS packet and bit 1 indicating whether this is the last CCSDS packet. More...
enum	_CCSDS_SEQUENCE_FLAGS_K {   CCSDS_SEQUENCE_FLAGS_K_MIDDLE = 0,   CCSDS_SEQUENCE_FLAGS_K_FIRST = CCSDS_SEQUENCE_FLAGS_M_FIRST,   CCSDS_SEQUENCE_FLAGS_K_LAST = CCSDS_SEQUENCE_FLAGS_M_LAST,   CCSDS_SEQUENCE_FLAGS_K_ONLY }
	Enumerates the state value represented by the sequence flags. More...
Functions
static __inline int	CCSDS_sequenceFlagsIsOnly (int flags)
	Test if the sequence flags indicate that this is the only packet.
static __inline int	CCSDS_sequenceFlagsIsFirst (int flags)
	Test if the sequence flags indicate that this is the first packet.
static __inline int	CCSDS_sequenceFlagsIsLast (int flags)
	Test if the sequence flags indicate that this is the last packet.
static __inline int	CCSDS_sequenceFlagsIsMiddle (int flags)
	Test if the sequence flags indicate that this is a middle packet.

---

Detailed Description

Maps out the CCSDS packet header sequence flags.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: CCSDS_sequenceFlags.h,v 1.2 2008/12/06 19:29:27 russell Exp $

---

Typedef Documentation

CCSDS_SEQUENCE_FLAGS_K

Typedef for CCSDS_SEQUENCE_FLAGS_K.

While the sequence flags are formally defined as two separate 1-bit fields, a bit indicating whether this is the first packet in (potentially) a sequence and a bit indicating whether this is the last bit in (potentially) a sequence, it is sometimes convenient to view the combination as defining a value 0-3 and naming the values

• 00 (0) Neither the first nor last packet in a sequence, therefore a middle packet
• 01 (1) The first packet in a sequence
• 10 (2) The last packet in a sequence
• 11 (3) Both the first and last packet, therefore the only packet

---

Enumeration Type Documentation

enum _CCSDS_SEQUENCE_FLAGS_K

Enumerates the state value represented by the sequence flags.

Enumerator:

CCSDS_SEQUENCE_FLAGS_K_MIDDLE	This is a middle packet in a sequence of packets
CCSDS_SEQUENCE_FLAGS_K_FIRST	This is the first packet in a sequence of packets
CCSDS_SEQUENCE_FLAGS_K_LAST	This is the last packet in a sequence of packets
CCSDS_SEQUENCE_FLAGS_K_ONLY	This is the only packet, i.e. not a sequence (literally this is both the first and last packet

enum _CCSDS_SEQUENCE_FLAGS_M

The CCSDS sequence flags. This is really a 2 bit a value with bit 0 indicating whether this is the first CCSDS packet and bit 1 indicating whether this is the last CCSDS packet.

Enumerator:

CCSDS_SEQUENCE_FLAGS_M_FIRST	The packet is the first
CCSDS_SEQUENCE_FLAGS_M_LAST	The packet is the last

enum _CCSDS_SEQUENCE_FLAGS_V

The CCSDS sequence flags, right shift. This is really a 2 bit a value with

• bit 0 indicating whether this is the first CCSDS packet
• bit 1 indicating whether this is the last CCSDS packet.

Enumerator:

CCSDS_SEQUENCE_FLAGS_V_FIRST	The packet is the first
CCSDS_SEQUENCE_FLAGS_V_LAST	The packet is the last

---

Function Documentation

static __inline int CCSDS_sequenceFlagsIsFirst

(

int

flags

)

[static]

Test if the sequence flags indicate that this is the first packet.

Return values:

	==	0 if not the first packet
	!=	0 if is the first packet

Parameters:

flags

The sequence flags

References CCSDS_SEQUENCE_FLAGS_M_FIRST.

static __inline int CCSDS_sequenceFlagsIsLast

(

int

flags

)

[static]

Test if the sequence flags indicate that this is the last packet.

Return values:

	==	0 if not the last packet
	!=	0 if is the last packet

Parameters:

flags

The sequence flags

References CCSDS_SEQUENCE_FLAGS_K_LAST.

static __inline int CCSDS_sequenceFlagsIsMiddle

(

int

flags

)

[static]

Test if the sequence flags indicate that this is a middle packet.

Return values:

	==	0 if not a middle packet
	!=	0 if is a middle packet

Parameters:

flags

The sequence flags

References CCSDS_SEQUENCE_FLAGS_K_MIDDLE.

static __inline int CCSDS_sequenceFlagsIsOnly

(

int

flags

)

[static]

Test if the sequence flags indicate that this is the only packet.

Return values:

	==	0 if not the only packet
	!=	0 if is the only packet

Parameters:

flags

The sequence flags

References CCSDS_SEQUENCE_FLAGS_K_ONLY.