Merge pull request #102 from jphickey/fix-92-use-payload

Fix #92, Use payload sub-struct in all messages

docs/dox_src/cfs_ds.dox

@@ -50,15 +50,15 @@
 
 /**
   \page cfsdsintro CFS Data Storage Introduction
-	
+
   <H2> Scope </H2>
 
   This document provides a complete specification for the commands and telemetry associated
-  with the CFS Data Storage (DS) application software.  The document is intended primarily 
-  for users of the software (operations personal, test engineers, and maintenance personnel).  
-  The last section of the document, the deployment guide section, is intended for mission 
-  developers when deploying and configuring the application software for a mission 
-  flight software build environment. 
+  with the CFS Data Storage (DS) application software.  The document is intended primarily
+  for users of the software (operations personal, test engineers, and maintenance personnel).
+  The last section of the document, the deployment guide section, is intended for mission
+  developers when deploying and configuring the application software for a mission
+  flight software build environment.
 
   \ref cfsdsversion
 
@@ -108,7 +108,7 @@
 
 /**
   \page cfsdsovr CFS Data Storage Overview
-	
+
   The CFS DS application is responsible for storing messages in files. These files are generally stored on a storage device such as a solid state recorder but they could be stored on any file system. Another application such as CFDP must be used in order to transfer the files created by DS to the ground. The DS software context diagram is shown in Figure DS-1.
 
   \image html CFS_DS_Context.jpg "Figure DS-1: Software Context Diagram"
@@ -124,9 +124,9 @@
 
 /**
   \page cfsdsopr CFS Data Storage Operation
-  
+
   When DS receives a message that passes the filtering algorithm, the message is stored in a file or files based upon the File Table information for that message ID. Once a message is stored, the DS Housekeeping packet displays information about the open file. Each houskeeping cycle, DS evaluates the open files to determine if their age has been exceeded. If this determination is true, the file is closed by the DS application. Also, each time a message is to be stored, DS determines if the message will fit in the open file. If the determination is false, the open file will be closed and a new file created containing the message. A minimum of one message will be stored each file.
-   
+
   <h2>Filtering</h2>
   Filtering is based upon message IDs. The Filter Table determines what messages DS will store. The DS application supports two types of filtering:
  <ol><li>Sequence number based filtering</li>
@@ -141,7 +141,7 @@
 
 /**
   \page cfsdsdg  CFS Data Storage Deployment Guide
-  
+
   To integrate the DS application, follow the CFS App Integration Guide.
   Also, be sure to set up the configuration parameters and message IDs for
   the platform.
@@ -150,7 +150,7 @@
   If the DS_MOVE_FILES configuration parameter is set to TRUE, the telemetry
   database, Destination File table load images and the File Table display page
   require changes. The Destination File Table rdl file uses the DS_MOVE_FILES
-  definition in the ds_platform_cfg.h file. However, in order to get the 
+  definition in the ds_platform_cfg.h file. However, in order to get the
   required parameter included in telemetry, this configuration parameter must be
   set to 1 rather than TRUE. The table images must include this parameter in
   order to load successfully and the display page must be modified to display
@@ -160,25 +160,25 @@
 /**
   \page cfsdstbl CFS Data Storage Table Definitions
 
-  <H2>Destination File Table</H2> 
+  <H2>Destination File Table</H2>
 
-  The Destination File Table is defined by #DS_DestFileTable_t. This table 
+  The Destination File Table is defined by #DS_DestFileTable_t. This table
   contains a description and #DS_DEST_FILE_CNT entries. Each entry is defined by
   #DS_DestFileEntry_t.
 
-  <H2>Filter Table</H2> 
+  <H2>Filter Table</H2>
 
-  The Filter Table is defined by #DS_FilterTable_t. This table contains a 
+  The Filter Table is defined by #DS_FilterTable_t. This table contains a
   description and #DS_PACKETS_IN_FILTER_TABLE entries. Each entry is defined by
   #DS_PacketEntry_t. Each Packet entry contains the Message ID for DS to store
   and #DS_FILTERS_PER_PACKET entries defined by #DS_FilterParms_t.
 
-  The Data Storage (DS) application attempts to load the File and Filter Tables from #DS_DEF_DEST_FILENAME and #DS_DEF_FILTER_FILENAME upon startup. 
-  If the load fails for either of these tables, DS will still start in the mode of operation as defined by the #DS_DEF_ENABLE_STATE configuration 
-  parameter.  If this configuration parameter is set to ENABLED mode and either the File and/or Filter Table failed to load, DS will not store any 
-  messages until both tables are loaded with valid data. This can be accomplished by using the cFE Table Services commands after creating a table 
-  load image file and uploading it to the spacecraft's file system.  Until both tables are loaded with valid data, DS will increment the 
-  #DS_HkPacket_t.IgnoredPktCounter for each received packet that is discarded. 
+  The Data Storage (DS) application attempts to load the File and Filter Tables from #DS_DEF_DEST_FILENAME and #DS_DEF_FILTER_FILENAME upon startup.
+  If the load fails for either of these tables, DS will still start in the mode of operation as defined by the #DS_DEF_ENABLE_STATE configuration
+  parameter.  If this configuration parameter is set to ENABLED mode and either the File and/or Filter Table failed to load, DS will not store any
+  messages until both tables are loaded with valid data. This can be accomplished by using the cFE Table Services commands after creating a table
+  load image file and uploading it to the spacecraft's file system.  Until both tables are loaded with valid data, DS will increment the
+  #DS_HkTlm_Payload_t.IgnoredPktCounter for each received packet that is discarded.
 **/
 
 /**
@@ -194,12 +194,12 @@
   </B> <BR> <BR> <I>
      The Message IDs to be stored are specified in the Filter Table. To determine what these are, you must dump the filter table. This can be done by displaying the Filter Table display page and clicking the Refresh button.
   </I>
-  
+
   <B> (Q) Where are my files being stored?
   </B> <BR> <BR> <I>
      The locations of the files are determined by the File Table entry that the message ID is associated with. The Filter table indicates what File index is being used to store that message IDs data. To trace the message ID to the File entry, both tables must be dumped. This can be done by displaying the File and Filter Table display pages and clicking the Refresh buttons on each page.
   </I>
-  
+
   <B> (Q) How are my files named?
   </B> <BR> <BR> <I>
      The files are named as follows:<BR><BR>