.:ioPython:home: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 3: | Line 3: | ||
=Purpose= | =Purpose= | ||
Creates an object of the ADPAA class. Built-in methods allow data within a UND | Creates an object of the ADPAA class. Built-in methods allow data within a NASA/UND-formatted ASCII file to be extracted and stored in an object of the ADPAA class and allow information within an object of the ADPAA class to be written to a file in proper NASA/UND format. | ||
=Imported Modules= | =Imported Modules= | ||
| Line 17: | Line 17: | ||
==ReadFile== | ==ReadFile== | ||
ReadFile([name= ]) | ReadFile([name= ]) | ||
* Purpose: Read a UND | * Purpose: Read a NASA/UND-formatted ASCII file into the ADPAA class. | ||
* Input: 'name' - optional keyword argument to set the filename of the file to input (uses ADPAA class attribute 'name' by default). | * Input: 'name' - optional keyword argument to set the filename of the file to input (uses ADPAA class attribute 'name' by default). | ||
* Returns: nothing | * Returns: nothing | ||
| Line 23: | Line 23: | ||
==WriteFile== | ==WriteFile== | ||
WriteFile([name= ]) | WriteFile([name= ]) | ||
* Purpose: Write information contained in an ADPAA object to a properly-formatted UND | * Purpose: Write information contained in an ADPAA object to a properly-formatted NASA/UND ASCII file. | ||
* Input: 'name' - optional keyword argument to set the filename of the file being written to (uses ADPAA class attribute 'name' by default) | * Input: 'name' - optional keyword argument to set the filename of the file being written to (uses ADPAA class attribute 'name' by default) | ||
* Returns: nothing | * Returns: nothing | ||
Revision as of 01:22, 25 January 2019
Module Name
adpaa.py (ADPAA class)
Purpose
Creates an object of the ADPAA class. Built-in methods allow data within a NASA/UND-formatted ASCII file to be extracted and stored in an object of the ADPAA class and allow information within an object of the ADPAA class to be written to a file in proper NASA/UND format.
Imported Modules
- readfile.py (ReadFile class)
- writefile.py (WriteFile class)
- constants.py (constants class)
- julian_date.py (julian_date class)
- adpaa_help.py (adpaa_help class)
Data Input/Output
The methods within an instantiated object of the ADPAA class that allow for data input/output are described below.
ReadFile
ReadFile([name= ])
- Purpose: Read a NASA/UND-formatted ASCII file into the ADPAA class.
- Input: 'name' - optional keyword argument to set the filename of the file to input (uses ADPAA class attribute 'name' by default).
- Returns: nothing
WriteFile
WriteFile([name= ])
- Purpose: Write information contained in an ADPAA object to a properly-formatted NASA/UND ASCII file.
- Input: 'name' - optional keyword argument to set the filename of the file being written to (uses ADPAA class attribute 'name' by default)
- Returns: nothing