The header element
Prev Schematic overview of DAVEfunc Next

The header element

The fileHeader element contains information about the source of the data contained within the DAVEfunc major element, including the author, creation date, description, reference information, and a modification history. 

    fileHeader : [name]
        author : name, org, [email]
            contactInfo* :
        fileCreationDate : date
        fileVersion? : 
            (version identification, character data)
        description? :
            (description of model, character data)
        reference* : refID, author, title, date, [accession, href]
            description? :
                (description of reference,  character data)
        modificationRecord* : modID, [refID]
            author : name, org, [email]
                address? :
                    (address character data)
                description? :
                    (description of modification, character data)
            extraDocRef? : refID

fileHeader sub-elements:

author

Name, organization, and optional email address of the author

fileCreationDate

Creation date of this file. See the "Additional DAVE-ML conventions" section later in this document for the recommended format.

fileVersion

A string that indicates the version of the document. No convention is specified for the format, but best practices would include an automated revision number from a configuration control process.

description

Optional but recommended text description: what does this DAVE-ML file represent?

reference

A list of zero or more references with a document-unique ID (must begin with alpha character), author, title, date, and optional accession and URL of the reference. Can include a description of the reference.

modificationRecord

An optional list of modifications with optional reference pointers, as well as author information and descriptions for each modification record. These modifications are referred to by individual function tables and/or data points, using the AIAA modification letter convention. If more than one document is associated with the modification, multiple sub-element extraDocRefs may be used in place of the modificationRecord 's refID attribute.

Example 1. An example of a fileHeader element

<!--                          =================                          --> 1
<!-- =========================   FILE HEADER   ========================= -->
<!--                          =================                          -->


  <fileHeader> 2
    <author name="Bruce Jackson" org="NASA Langley Research Center" email="[email protected]">
      <address>MS 132 NASA, Hampton, VA 23681</address>
    </author>
    <fileCreationDate date="2003-03-18"/> 3

    <fileVersion>$Revision: 1.24 $</fileVersion> 4

    <description>
     Version 2.0 aero model for HL-20 lifting body, as described in
     TM-107580. This aero model was used for HL-20 approach and
     landing studies at NASA Langley Research Center during 1989-1995
     and for a follow-on study at NASA Johnson Space Center in 1994
     and NASA Ames Research Center in 2001. This DAVE-ML version
     created 2003 by Bruce Jackson to demonstrate DAVE-ML.
    </description>

    <reference refID="REF01" 5
        author="Jackson, E. Bruce; Cruz, Christopher I. & and Ragsdale, W. A." 
        title="Real-Time Simulation Model of the HL-20 Lifting Body" 
        accession="NASA TM-107580"
        date="1992-07-01"
    />

    <reference refID="REF02" 
        author="Cleveland, William B. <[email protected]>" 
        title="Possible Typo in HL20_aero.xml" 
        accession="email" 
        date="2003-08-19"
    />

    <modificationRecord modID="A" refID="REF02"> 6
      <author name="Bruce Jackson" org="NASA Langley Research Center" 
        email="[email protected]">
        <address>MS 132 NASA, Hampton, VA 23681</address>
      </author>
      <description>
        Revision 1.24: Fixed typo in CLRUD0 function description which
        gave dependent signal name as "CLRUD1." Bill Cleveland of NASA
        Ames caught this in his xml2ftp script. Also made use of 1.5b2
        fileHeader fields and changed date formats to comply with
        convention.
      </description>
    </modificationRecord>

  </fileHeader>
1

Use of comments makes these big files more readable by humans.

2

Start of fileHeader element.

3

See the note regarding date format convention below.

4

In this example, the revision number is automatically inserted by CVS or RCS, an automated versioning system.

5

All documents referenced by notation throughout the file should be described here, in reference elements.

6

All modifications made to the contents of this file should be given here for easy reference in separate modificationRecord elements.


Prev Up Next
Schematic overview of DAVEfunc Home | ToC The variable definition element