.
1 _
INTRODUCTION
.
This document is a reference manual that deals with the standard SEDRIS
application function calls, as well as critical data structures. The parameters
associated with each function call are detailed, and the resultant processing
is described.
.
1.1 _
Prerequisites
.
It is recommended that the following documents from the SEDRIS Technology
Documentation Set (see Section 1.2) be reviewed prior to reading
this document.
- Part 3: SEDRIS Basics
- .
- Part 4, Volume 1: Technical Overview
- .
- Part 4, Volume 2: The SEDRIS Data Representation Model
- .
- Part 4, Volume 12: Application Programmer's Interface Overview
1.2 _
For Additional Information on SEDRIS
.
This document is part of a larger set of overview and technical documents
on SEDRIS, the Technology Documentation Set. The Technology Documentation
Set describes the why, what, and how of SEDRIS.
.
The Technology Documentation Set, listed below, is available at the
SEDRIS web site (www.sedris.org).
An overview of the contents of each "part" of the documentation
set is provided in Part 1. A detailed description of the individual "volumes"
contained in Part 4 is provided in Volume 1.
- Part 1: Introduction to SEDRIS and the Technology Documentation
Set
- .
- Part 2: SEDRIS and The Synthetic Environment Domain
- .
- Part 3: SEDRIS Basics
- .
- Part 4: Technical Reference Set
- Volume 1: Technical Overview
- Volume 2: The SEDRIS Data Representation Model
- Volume 3: Examples of Using the Data Representation Model
- Volume 4: Topology Technical Guide
- Volume 5: Control Link Technical Guide
- Volume 6: Data Tables Technical Guide
- Volume 7: Hierarchical Table Technical Guide
- Volume 8: Images and Color Models Technical Guide
- Volume 9: Attribute Inheritance and Context Technical Guide
- Volume 10: Environmental Classification, Attribute, and State Coding
Specification
- Volume 11: Spatial Reference Model
- Volume 12: Application Programmer's Interface Overview
- Volume 13: How to Extract Data from SEDRIS Transmittals
- Volume 14: How to Produce SEDRIS Transmittals
- Volume 15: SEDRIS Transmittal Format Description
- Volume 16: Guide to the Build Kit
- Volume 17: SEDRIS Reference Manual _
(This document)
- Volume 18: Reference Implementation Listings
- .
- Part 5: Tools and Utilities User's Guide Set
- Volume 1: Browser User's Guide
- Volume 2: Syntax Checker User's Guide
- Volume 3: Depth User's Guide
- Volume 4: Feature Viewer User's Guide
- Volume 5: Model Viewer User's Guide
- Volume 6: Netscape Plug-In User's Guide
- Volume 7: Ocean Profile User's Guide
- Volume 8: SEE-IT User's Guide
- Volume 9: Side-By-Side Viewer User's Guide
- Volume 10: Wind Map User's Guide
- Volume 11: API Implementations and Format Conversions User's Guide
- .
- Part 6: Procedures and Processes Manual
1.3 _
Document Conventions and Notations
.
Throughout the SEDRIS Technology Documentation
Set, special conventions and notations are implemented in the written text
of documents to distinguish between and add emphasis to various computer-related
or SEDRIS-specific terms. The table below defines these conventions and
notations.
.
|
CONVENTION
|
EXAMPLES
|
DEFINITIONS
|
|
Reverse video
|
|
window buttons/selections/choices/etc.
|
|
<Key or Class>
|
<Shift>
.
<Color Data>
.
|
keys on the keyboard
.
SEDRIS DRM data class names *
(e.g., Color_Data = <Color Data>)
|
.
Courier font
|
libsrc / api_impl / ...
.
gmake env
.
SE_COLOR_MODEL_ENUM
.
"false"
|
directory, file, transmittal, library names
.
command line input
.
variable names and coding examples
.
variable values
|
|
italics
|
www.sedris.org
.
gmake
.
.
Part 1: Intro to �
.
not always
|
Internet addresses
.
software, window, mode, function, option, etc. names
.
document/section titles
.
for emphasis
|
|
"quotes"
|
"generic"
|
highlight or call attention to
|
|
.
|
*
Underscore characters ( _ ) are not always replaced by angle
brackets (< >),
_.depending
upon where data class names appear. Angle brackets appear within
._paragraph
text (to avoid word wrap), whereas underscore characters are used in
._lists
or other stand-alone text (for clarity) and are used in coding examples.
|
Return to: Top of this
Page
|