1 / 7

Using Module Headers

Discover the importance and locations of module headers for FORTRAN, C, IDL (Icy), and MATLAB (Mice) Toolkits. Detailed user information and examples provided. Key entry points for various modules highlighted. Find headers within source code or documentation directories. Access HTML versions for enhanced readability. Familiarize yourself with module headers to optimize Toolkit implementation.

weeksj
Download Presentation

Using Module Headers

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Using Module Headers October 2007

  2. Module Header Purpose • Module “headers” are provided for all Toolkit modules, whether FORTRAN, C, IDL, or MATLAB Toolkits. • Depending on the language, these “headers” may be found within the source code, under the …/doc directory, or both. (All headers are available from the Toolkit API Reference Guide.) • This is the fundamental source for detailed user information and examples on how to use the module. • For some families of modules (e.g. SPK), additional information about the whole family is provided in a “required reading” document (e.g. …/doc/spk.req) Using Module Headers

  3. FORTRAN Module Header Locations • For FORTRAN toolkits, the headers are provided within the source code modules. • <path to SPICELIB>/toolkit/src/spicelib/<name.f or <name>.for • HTML versions of the headers are also available: • <path to SPICELIB>/toolkit/doc/html/spicelib/index.html • In most cases there is a single “header” at the top of the source code. • In a few cases, where a FORTRAN module has multiple entry points, there are additional “headers” at each entry point. For example: • “keeper.f” has entries for FURNSH, KTOTAL, KINFO, KDATA, KCLEAR, and UNLOAD Using Module Headers

  4. C Module Header Locations • For C toolkits the headers are provided in two formats, at two locations. • Plain text, in the source code headers: • <path to CSPICE>/cspice/src/cspice/<name>_c.c • HTML: • <path to CSPICE>/cspice/doc/html/cspice/index.html Using Module Headers

  5. Icy Module Header Locations • For IDL (“Icy”) toolkits, two kinds of headers are provided. • Icy wrappers in HTML format: • <path to icy>/icy/doc/html/icy/index.html • This is a restricted set of information, and refers the user to the corresponding cspice header for details. • cspice headers, in text and HTML formats: • <path to icy>/icy/src/cspice/<name>_c.c • <path to icy>/icy/doc/html/cspice/index.html • The information provided in an “Icy” wrapper is minimal; the corresponding CSPICE wrapper provides more detail. Using Module Headers

  6. Mice Module Header Locations • For MATLAB (“Mice”) toolkits, two kinds of headers are provided. • Mice wrappers in HTML format: • <path to Mice>/mice/doc/html/mice/index.html • This is a restricted set of information, and refers the user to the corresponding cspice header for details. • The user can also access the information presented in the HTML document via the MATLAB help command. • cspice headers, in text and HTML formats: • <path to Mice>/mice/src/cspice/<name>_c.c • <path to Mice>/mice/doc/html/cspice/index.html • The information provided in a “Mice” wrapper is minimal; the corresponding CSPICE wrapper provides more detail. Using Module Headers

  7. Look at a Typical Header • Check one out… whether FORTRAN, C, Icy or Mice. • Suggestion, look for one of these headers: • SPKEZR, spkezr_c, cspice_spkezr, cspice_spkezr • STR2ET, str2et_c, cspice_str2et, cspice_str2et Using Module Headers

More Related