Index Page
cidfrm_c
A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 

Procedure
Abstract
Required_Reading
Keywords
Brief_I/O
Detailed_Input
Detailed_Output
Parameters
Exceptions
Files
Particulars
Examples
Restrictions
Literature_References
Author_and_Institution
Version
Index_Entries

Procedure

   void cidfrm_c ( SpiceInt        cent,
                   SpiceInt        lenout,
                   SpiceInt      * frcode,
                   SpiceChar     * frname,
                   SpiceBoolean  * found  ) 

Abstract

 
   Retrieve frame ID code and name to associate with a frame center. 
 

Required_Reading

 
   None. 
 

Keywords

 
   FRAMES 
 

Brief_I/O

 
   VARIABLE  I/O  DESCRIPTION 
   --------  ---  -------------------------------------------------- 
   cent       I   An object to associate a frame with. 
   lenout     I   Available space in output string frname.
   frcode     O   The ID code of the frame associated with cent.
   frname     O   The name of the frame with ID frcode.
   found      O   SPICETRUE if the requested information is available. 
 

Detailed_Input

 
   cent        is the ID code for object for which there is a 
               preferred reference frame. 
               
   lenout      is the available space in the output string frname,
               including room for the terminating null character.
 

Detailed_Output

 
   frcode      is the frame ID code to associate with the object 
               specified by cent. 
 
   frname      is the name of the frame that should be associated 
               with the object specified by cent. 
 
   found       is SPICETRUE if the appropriate frame ID code and frame 
               name can be determined.  Otherwise found is returned 
               with the value SPICEFALSE. 
 

Parameters

 
   None. 
 

Exceptions

 
   None. 
 

Files

 
   None. 
 

Particulars

 
   This routine allows the user to determine the frame that should 
   be associated with a particular object.   For example, if you 
   need the frame to associate with the Io, you can call cidfrm_c 
   to determine the frame name and ID code for the bodyfixed frame 
   of Io. 
 
   The preferred frame to use with an object is specified via one 
   of the kernel pool variables: 
 
       OBJECT_<cent>_FRAME 
 
   where <cent> is the decimal representation of the integer cent. 
 
   For those PCK objects that have "built-in" frame names this 
   routine returns the corresponding "IAU" frame and frame ID code. 
 

Examples

 
   Suppose that you want to determine the state of a target in the
   preferred reference frame of some observer.  This routine can be
   used in conjunction with spkezr_c to compute the state.
 
      #include <stdlib.h>
      #include <stdio.h>
      #include "SpiceUsr.h"
      
      #define LENOUT   32
           .
           .
           .
           
      cidfrm_c ( obs, LENOUT, &frcode, frname, &found ); 
      
      if ( !found )
      {
         printf ( "The bodyfixed frame for object %d\n" 
                  "could not be identified.\n",
                  obs                                   );
         exit(1);
      }
 
      spkezr_c ( targ, et, frname, abcorr, obs, state, &lt );
       
 

Restrictions

 
   None. 
 

Literature_References

 
    None. 
 

Author_and_Institution

 
    N.J. Bachman    (JPL)
    W.L. Taber      (JPL) 
 

Version

 
   -CSPICE Version 1.0.0, 22-JUL-1999 (NJB) (WLT)

Index_Entries

 
   Fetch reference frame attributes 
 
Wed Apr  5 17:54:29 2017