Doxygen Documentation
	Main Index	Package Index
	Package:	CCSDS
	Version:	V3-2-1	Marked:	(not marked)
	Constituent:	ccsds_pkt_test	Tag:	linux-gcc

---

         

---

ccsds_pkt_test.c File Reference

#include "stdio.h"
#include "stdlib.h"
#include "string.h"
#include "CCSDS/CCSDS_pkt.h"
#include "CCSDS/CCSDS_dump.h"
#include "CCSDS/ccsds_pkt_test.h"
#include "CLI/CLI_pubdefs.h"
#include "MSG/MSG_pubdefs.h"
#include "MSG/MSG_printProc.h"
#include "PBS/TASK.h"

Data Structures
struct	_Pkt_Test_Config
Typedefs
typedef enum _Pkt_Test_State	Pkt_Test_State
typedef _Pkt_Test_Config	Pkt_Test_Config
Enumerations
enum	_Pkt_Test_State {   PKT_TEST_STATE_EMPTY,   PKT_TEST_STATE_CREATED }
Functions
unsigned int	pt_create (CLI_Control *control, Pkt_Test_Config *config)
unsigned int	pt_set (CLI_Control *control, Pkt_Test_Config *config)
unsigned int	pt_get (CLI_Control *control, Pkt_Test_Config *config)
unsigned int	pt_dump (CLI_Control *control, Pkt_Test_Config *config)
unsigned int	pt_help (CLI_Control *control, Pkt_Test_Config *config)
unsigned int	pt_exit (CLI_Control *control, Pkt_Test_Config *config)
void	pt_print (Pkt_Test_Config *config)
int	main (int argc, char **argv)
Variables
Pkt_Test_Config	ptconfig

---

Detailed Description

Author:

D.L. Wood

CCSDS packet format test program.

---

Typedef Documentation

Pkt_Test_Config

The typedef for _Pkt_Test_Config.

Pkt_Test_State

The typedef for _Pkt_Test_State.

---

Enumeration Type Documentation

enum _Pkt_Test_State

Defines the state of the test application. Enumeration values: PKT_TEST_STATE_EMPTY  A test packet has not yet been created. PKT_TEST_STATE_CREATED  A test packet has been created.

---

Function Documentation

int main (  int  argc, char **  argv )

The application entry point. Parameters: argc  The number of command line args. argv  The list of command line args. Return values: 0  Success. -1  Failure.

unsigned int pt_create (  CLI_Control *  control, Pkt_Test_Config *  config )  [static]

Creates a new packet in response to the "create" command. Parameters: control  The CLI control structure. config  A pointer to the application configuration info. Return values: CLI_SUCCESS  Success. CLI_BADSNTX  The command did not have proper syntax.

unsigned int pt_dump (  CLI_Control *  control, Pkt_Test_Config *  config )  [static]

Displays the contents of the entiere packet header. Parameters: control  The CLI control structure. config  A pointer to the application configuration info. Return values: CLI_SUCCESS  Success. CLI_BADSNTX  The command did not have proper syntax or the test packet has not been created.

unsigned int pt_exit (  CLI_Control *  control, Pkt_Test_Config *  config )  [static]

Quits the application in reponse to the "exit" command. Parameters: control  The CLI control structure. config  A pointer to the application configuration info. Returns: CLI_ENDOFCMD to stop the CLI interpreter.

unsigned int pt_get (  CLI_Control *  control, Pkt_Test_Config *  config )  [static]

Retrieves a value from the test packet in response to the "get" command. Parameters: control  The CLI control structure. config  A pointer to the application configuration info. Return values: CLI_SUCCESS  Success. CLI_BADSNTX  The command did not have proper syntax or the test packet has not been created.

unsigned int pt_help (  CLI_Control *  control, Pkt_Test_Config *  config )  [static]

Prints a summary of the command syntax in response to the "help" command. Parameters: control  The CLI control structure. config  A pointer to the application configuration info. Returns: CLI_SUCCESS

void pt_print (  Pkt_Test_Config *  config  )  [static]

Displays the hex dump of the test packet contents. Parameters: config  A pointer to the application configuration info.

unsigned int pt_set (  CLI_Control *  control, Pkt_Test_Config *  config )  [static]

Sets a value in the test packet in response to the "set" command. Parameters: control  The CLI control structure. config  A pointer to the application configuration info. Return values: CLI_SUCCESS  Success. CLI_BADSNTX  The command did not have proper syntax or the test packet has not been created.

---

Variable Documentation

ptconfig [static]

The test application global configuration info.

---