spkpds_c |
Table of contents
Procedurespkpds_c ( SPK pack descriptor ) void spkpds_c ( SpiceInt body, SpiceInt center, ConstSpiceChar * frame, SpiceInt type, SpiceDouble first, SpiceDouble last, SpiceDouble descr[5] ) AbstractPerform routine error checks and if all check pass, pack the descriptor for an SPK segment Required_ReadingSPK KeywordsSPK Brief_I/OVARIABLE I/O DESCRIPTION -------- --- -------------------------------------------------- body I The NAIF ID code for the body of the segment. center I The center of motion for body. frame I The frame for this segment. type I The type of SPK segment to create. first I The first epoch for which the segment is valid. last I The last epoch for which the segment is valid. descr O An SPK segment descriptor. Detailed_Inputbody is the NAIF ID code for the body of the segment. center is the center of motion for BODY. frame is a string that names the frame to which states for the body shall be referenced. type is the type of SPK segment to create. first is the first epoch for which the segment will have ephemeris data. last is the last epoch for which the segment will have ephemeris data. Detailed_Outputdescr is a valid SPK segment descriptor to use when creating a DAF segment for this body. ParametersNone. Exceptions1) If the value of `body' is 0, the error SPICE(BARYCENTEREPHEM) is signaled by a routine in the call tree of this routine. 2) If the values of `body' and `center' are the same, the error SPICE(BODYANDCENTERSAME) is signaled by a routine in the call tree of this routine. 3) If `frame' is not one of the known SPICE reference frames, the error SPICE(INVALIDREFFRAME) is signaled by a routine in the call tree of this routine. 4) If `first' is greater than or equal to `last', the error SPICE(BADDESCRTIMES) is signaled by a routine in the call tree of this routine. 5) If the value of `type' is outside the range 1 to 1000 (inclusive), the error SPICE(UNKNOWNSPKTYPE) is signaled by a routine in the call tree of this routine. This does not ensure that the `type' is a legitimate SPK segment type, but it is a simple check that helps avoid problems that arise from uninitialized values or improperly ordered calling arguments. 6) If the `frame' input string pointer is null, the error SPICE(NULLPOINTER) is signaled. 7) If the `frame' input string has zero length, the error SPICE(EMPTYSTRING) is signaled. FilesNone. ParticularsThis is a utility routine for validating and creating the descriptor for an SPK segment. It is intended for use only by routines that create SPK segments. ExamplesSuppose that you wish to create an SPK segment of type X and that you are writing a routine to handle the details of the segment creation. This routine can be used to ensure that the descriptor needed for the segment is properly formed and that the information in that descriptor is reasonable. Having collected the needed information you can create the descriptor and then begin a new segment as shown below. #include "SpiceUsr.h" . . . spkpds_c ( body, center, frame, type, first, last, descr ); dafbna_c ( handle, descr, segid ); RestrictionsNone. Literature_ReferencesNone. Author_and_InstitutionN.J. Bachman (JPL) J. Diaz del Rio (ODC Space) K.R. Gehringer (JPL) W.L. Taber (JPL) Version-CSPICE Version 1.0.1, 05-AUG-2021 (JDR) Edited the header to comply with NAIF standard. -CSPICE Version 1.0.0, 19-JUL-1999 (NJB) (KRG) (WLT) Index_EntriesValidate and pack an SPK segment descriptor |
Fri Dec 31 18:41:12 2021