Thank you for downloading this release of the SEDRIS Software Development Kit (SEDRIS SDK). The SEDRIS SDK is the development environment for building applications and components that can unambiguously represent and interchange environmental data. This release of the SEDRIS SDK offers significant improvements in functionality and performance, including a reduced memory footprint, faster access to transmittals, and smaller transmittal file sizes.
This release has been tested on multiple platforms, such as Linux, Irix, Sun, and Windows 98/Me/NT/2000. For detailed information on platform and compiler versions supported see the Build Kit.
The SDK includes tools useful for accessing, testing, and viewing SEDRIS Transmittal Format (STF) files (also called transmittals). Some of these tools are designed to be used from the command line, but there is also an application that can display 3D geometry present in a transmittal using the OpenGL libraries. More information on these applications is available in the Tools and Utilities page.
This release is compatible with the following SEDRIS technology components:
- Data Representation Model (DRM), version 3.1
- Spatial Reference Model (SRM), version 3.1
- Environmental Data Coding Specification (EDCS), version 3.0
- Read and Write Application Programmer's Interface (API), version 3.1
- SEDRIS Transmittal Format (STF), version 3.1
This release includes the following SEDRIS implementations:
- Reference DRM implementation, version 3.1.1
- Reference SRM implementation, version 3.1.1
- Reference EDCS implementation, version 3.0.1
- Reference API implementation, version 3.1.1
- Reference STF implementation, version 3.1.1
The EDCS and SRM will be updated on a regular basis, probably at a faster rate than the other SEDRIS technology components. New versions of these components will easily integrate into your current SEDRIS environment using simple file replacements.
For help, comments, and bug reports please send email to help@sedris.org. If you are an associate, please use se-coders@sedris.org.
Return to: Top
This version of the SDK is being made available in multiple distribution formats. In addition to source code, pre-compiled binaries for all supported platforms can be downloaded from the SEDRIS web site (www.sedris.org). You may also download separate distributions of the EDCS SDK and SRM SDK technology components in both source and pre-compiled binaries form.
The following matrix table shows the contents of the different packages for the SEDRIS SDK distributions and the directories you will find in them (note that the links on the column headers take you to the directories, so they may not work depending on your distribution and, as in the case of a source distribution, on whether you have compiled the libraries and/or applications):
Package and Contents bin: Compiled binaries for applications
docs: Documentation, including Release Notes, Migration Guide, Reference Manual
include: Headers for SEDRIS Technology Components
lib: Compiled binaries for libraries
src: Source code for SEDRIS Technology Components and Applications
transmittals: Sample SEDRIS STF transmittals
Complete Suite Source:
- All SEDRIS Technology Components
- All SDK Applications
X X X Complete Suite Binary:
- All SEDRIS Technology Components
- All SDK applications
X X X X X Return to: Top
The following table may assist developers in finding the documentation that best matches their needs:
Release Notes Fixes and Limitations Build Kit Migration Guide Tools And Utilities SDK Reference Manual New user with
binary distributionRead Read Read Read New user with
source code distributionRead Read Read Read Read Experienced user with
binary distributionRead Read Read Read Experienced user with
source code distributionRead Read Read Read Read Return to: Top
The SEDRIS SDK is distributed as a GNU-zipped tar file for Unix systems and a Zip file in Win32 systems. If you have obtained a source distribution, you will need to build the SDK after installation in order to run the applications and test your setup. Instructions for building the SDK are located in the Build Kit, along with instructions on Testing the Build. If you have a binary distribution, you can proceed to Testing the Build after finishing the installation.
Note: If you have an earlier version of the SDK and you haven't changed its default installation directory, you may want to do it now because this version of the SDK may overwrite it.
To install, extract the contents of the compressed file:
- Unix
Use the "tar" and "gzip" commands to extract the contents of the SDK:
using the appropriate filename for "sdk_file.tar.gz".gunzip -c sdk_file.tar.gz | tar xf -If you have GNU tar installed, you can use the following command instead:
tar xzf sdk_file.tar.gz
- Win32
Use WinZip or other decompression utility to extract the contents of the downloaded file.
See the Build Kit page for information on building the SDK, testing the build, and linking your applications and/or libraries against the libraries in this SDK.
Note that the file name for binary releases includes the OS/System architecture type as part of the name. After extracting the software, users should see a top-level "sedris" directory. Binary releases associated with different OS/architecture can be installed on a common "sedris" directory. This is to allow users who work on several platforms to install all the releases under a common "sedris" directory in a shared network drive. In that case, on each installation, the non-OS-specific files are replaced by the new release and the OS specific libraries and executables are stored under their respective sub-directories under the "lib" and "bin" directories discriminated by their platform/version/architecture combination.
Return to: Top
The SDK Documentation is divided into the following areas:
- Release Notes (this document)
- Describes the capabilities of this release, its contents, and supported platforms and compilers.
- Build Kit
- Details the build options and procedures for compiling and linking the software, how to test the build, and how to link applications and libraries against the SDK.
- Fixes And Limitations
- Describes the fixes and and known limitations of this release.
- SDK Reference Manual
- Provides links to detailed documents for the DRM, EDCS, SRM, API, and STF technology components.
- Tools and Utilities
- Describes the tools and utilities included with this release, such as Depth and Model Viewer.
- Migration Guide
- Provides information on procedures and utilities available to migrate applications from SDK Release 3.0.x to Release 3.1.
Return to: Top
This release includes several applications and sample data that demonstrate the use of the SEDRIS SDK to create and access STF files.
Applications (also see Tools and Utilities):
- Depth
- An application that traverses an STF file and dumps the objects in text format. See a sample run of the Depth tool.
- Model Viewer
- A 3D viewer that can display the <Model> geometry using OpenGL. See a sample run of the Model Viewer tool.
- Rules Checker
- A tool that checks the semantical correctness of an STF transmittal. See a sample run of the Rules Checker tool.
- Syntax Checker
- A tool that checks the syntactical correctness of an STF transmittal. See a sample run of the Syntax Checker tool.
- ITR Test
- An application that demonstrates the use of the Inter-Transmittal Referencing mechanism to link multiple STF files.
- STF Test
- A sample application that creates and populates an STF transmittal.
Sample STF transmittals and related files:
- test.stf
- Contains one <Model> with 3 polygons resembling a famous mouse. Uses LSR for its environment. There are no textures, features, or grids. There is one polygon in the <Environment Root> (green color).
- sample_comm.stf
- Contains a model of a communications console. It demonstrates texture mapping.
- sample_chair.stf
- Contains a somewhat complex model of an office chair.
- atm_grib.stf
- Contains sample atmospheric data (wind speed and temperature) stored in <Property Grid>.
- sedris.rsl
- A sample SEDRIS resolution file for resolving transmittal identifications in Uniform Resource Name (URN) to explicit transmittal root file names. This resolution file can be used in conjunction with the transmittals generated by the itr_test utility application to resolve all the necessary transmittal references. Redefine the root path in the sedris.rsl to the one in use.
Return to: Top
This section describes the following environment variable that are available for users to configure their runtime environment:
- SE_API_MEMORY_MODEL
This variable allows the user to specify, at a high level, the amount of memory to use. Its allowed values are SMALL, MEDIUM, and LARGE. The default setting is SMALL. Each of these three choices will set the default values to the subordinate memory model environment variables SE_RAIF_MAX_OBJECT_CACHE_SIZE and SE_STF_BLOCK_CACHE_SIZE:
- SE_RAIF_MAX_OBJECT_CACHE_SIZE
RAIF maintains a cache of objects that are not currently in use by any user application, i.e., these are objects that have no handles to them but which are cached for faster access. SE_RAIF_MAX_OBJECT_CACHE_SIZE specifies the number of objects that RAIF will maintain cache; the default is the minimum amount of 1024.
- SE_STF_BLOCK_CACHE_SIZE
This variable is used internally by STF to specify how many blocks to keep in memory. Every file contains 2048 blocks; the more blocks in memory the less have to be instantiated. The minimum value of this variable is 4096.
If SE_API_MEMORY_MODEL is set and the user overrides the subordinate variables, then the overriding values will be used.
The typical user will not care about these variables, in which case the default values will be used. In fact, most likely only the core developers will care about these variables, so that is why the Memory Model variable specifies one of three preset memory sizes rather than being more configurable. The following are the defaults for each choice:
Memory Model Default Setting SMALL
- SE_STF_BLOCK_CACHE_SIZE: 4096
- SE_RAIF_MAX_OBJECT_CACHE_SIZE: 1024
MEDIUM
- SE_STF_BLOCK_CACHE_SIZE: 8192
- SE_RAIF_MAX_OBJECT_CACHE_SIZE: 65536
LARGE
- SE_STF_BLOCK_CACHE_SIZE: 16384
- SE_RAIF_MAX_OBJECT_CACHE_SIZE: 131072
There are three considerations when setting these environment variables. The 3 areas where efficiency would be gained are:
- Object interconnectivity
- If a transmittal has a high amount of object sharing and hence is highly interconnected, the user could benefit by enlarging the memory model, which causes more objects to be maintained in memory. Since in highly interconnected transmittals, the same objects will be encountered many times, maintaining them in memory means that they will not have to be re-instantiated each time they are encountered. The API can directly access them and the user will have immediate access, rather than having to read them from disk or convert them in memory.
- Traversal algorithm
- The second area of impact depends on the user's Traversal algorithm. The user could benefit from memory model enlargement if the user consumes/produces transmittals in a manner in which the same transmittal areas are visited repeatedly. In the case where the user has simple depth-first traversal and processes most objects only once, there is no benefit in enlarging the memory model.
- <Data Table> production
- The third area affected is specific to data providers of <Data Tables>. Using a small memory model while a <Data Table> is being produced will optimize the <Data Table>'s size on disk, while a large memory model will optimize it for speed of consumption.
- SEDRIS_RESOLVER_PATH
This variable specifies the path(s) where the SEDRIS resolution (*.rsl) files reside. There can be more than one resolution file in the paths provided. The default path is where the running application resides.
- SE_WW15MGH_GRD_PATH
The SEDRIS conversions API supports limited vertical datum conversion using a data file provided in src/lib/srm: WWMGH15.BIG (for big-endian machines) and WWMGH15.LIT (for little-endian machines). To use vertical datum conversion, the users must set this environment variable to the absolute directory path where these files are found (without the file name).
Return to: Top
The first entry of the table below lists the SEDRIS Change Requests (SCRs) implemented in this release. An SCR is the means by which users make their requests for SEDRIS technology changes as either a functional enhancement or a software problem. Users can make such requests via the SCR Form Web Site. The SEDRIS Associates can review the status of the SCRs at the SEDRIS website while the non-associates can obtain their status by sending a request for specific SCRs to se-scrccb@sedris.org.
Please see Fixes And Limitations for detailed information on software fixes and known limitations/defects.
The following table entries provide a summary of the major improvements in each one of the SEDRIS technology components and changes to miscellaneous items such as the build environment and compiler support.
SEDRIS Change Requests (SCRs) addressed
- Core 160, 161, 165, 166, 167, 168, 169, 170, 173, 174, 177, 178
- E&S 026, 101
- JRM 104
- LMIS 122
- MITRE 111, 115, 124, 126, 128, 129
- NRL 104, 115, 116, 117
- PDB 016, 020, 021, 022, 024, 025, 026
- PUBLIC 115, 116, 117
- RBD 105
- SAIC 159, 164, 166, 168, 169
- SRI 003, 004
- TASC 124
- TERRASIM 001
DRM
- Added support for bump image signature.
- Added support for bi-direction reflectance distribution.
- Changed all the DRM aggregation relationships to be bi-directional.
- Changed code to allow "empty" features and geometry.
- Changed the relationships between <Feature Face> and <Feature Edge> to 2-way
- Changed the relationships between <Geometry Face> and <Geometry Edge> to 2-way.
- Changed all component relationship to 2-way.
- Modified fields of Keywords class to conform with current version of geospatial metadata standard.
- Simplified the DRM Link classes to reduce the number of specialized class by eliminating 29 classes.
- Removed <Bordered Feature Face> and <Bordered Geometry Face> from DRM.
SRM
- Added UTM validation via SRM_ValidateCoordinate.
- Added support for GCS validations and conversions.
- Added support for Horizontal Datum transformation.
- Added support for on-demand loading of the Geoidal Separation Table for WGS84.
EDCS
- Added support for mapping from label to code.
- Added support for mapping from FACC to EDCS .
- Added five new EDCS dictionaries:
- Organizational Schema (EO)
- Unit (EU)
- Scale (ES)
- Equivalence Class (EQ)
- Group (EG)
- Separated unit and scale.
- Upgraded to ISO compliant naming.
API
- Added checking to verify the DRM version in the root object against the DRM used to create the transmittal.
- Added the SE_GetUniqueTransmittalId function to support the assessment for the equality of transmittals.
- Added support for better return status reporting. This mechanism allows the user to get extended information on the reason for a returned status other than SE_SUCCESS.
- Added legal URN syntax checking.
- Extended the URN resolution procedure to look for "xmtl_name".rsl beyond the currently accepted sedris.rsl.
- Change SE_SetTransmittalRoot to take NULL as the old root object.
- Added several changes to the search filter functions including new macros containing options for ITR resolution choices.
- Renamed several data table related functions to add the word "Sub" before the word "Extent". For example: SE_PutDataTableExtent renamed SE_PutDataTableSubExtent.
- Removed SE_AddToTrasmittal function. The user no longer needs to call this function to commit an object to the transmittal.
- Removed Ids from library <Model>, <Image> and <Sound> components.
STF
- Support for more efficient STF processing that will automatically compress the transmittals. The initial results review a reduction of 60% in size for STF transmittals converted from S1000 with a very small processing overhead (roughly 1 second per file in STF).
MISC.
- Added support for Sun compiler 5.2 (Forte).
- Added support for GCC 3.0.1 compiler.
- Upgraded syntax_checker, rules_checker and depth applications to process -f <filename> command line option that redirects the output to a file.
- Upgraded syntax_checker to start processing from a particular object.
- Upgraded model_viewer to toggle on/off a bounding volume on the models and their individual components.
- Changed the default library build mode from Standard to Optimized.
- Added support to build a single library (static and dynamic) containing all the SEDRIS component libraries.
- Removed the Support layer and Dynamic API.
- Removed Traverse and Browser applications from the release.
Return to: Top
Questions, comments, and bug reports should be sent to help@sedris.org.
If you are an associate, please send email to se-coders@sedris.org.
Return to: Top
These links require Internet access.
Return to: Top
Copyright © 2002 SEDRIS™