1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
/*!
A Rust idiomatic CSPICE wrapper built with [procedural macros][`spice_derive`].
*/
use crate::{c, cstr, fcstr, get_scalar, get_varr, init_scalar, malloc, mallocstr, mptr};
use spice_derive::{cspice_proc, return_output};
use std::ops::{Deref, DerefMut};
#[cfg(any(feature = "lock", doc))]
use {crate::core::lock::SpiceLock, spice_derive::impl_for};
#[allow(clippy::upper_case_acronyms)]
pub type DLADSC = c::SpiceDLADescr;
#[allow(clippy::upper_case_acronyms)]
pub type DSKDSC = c::SpiceDSKDescr;
#[allow(clippy::upper_case_acronyms)]
pub type CELL = c::SpiceCell;
pub const CELL_MAXID: usize = 10_000;
/**
A cell is a data structure intended to provide safe array access within the applications.
See the [C documentation](https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/req/cells.html).
*/
#[derive(Debug)]
pub struct Cell(c::SpiceCell);
impl Cell {
/**
Declare a cell from integer.
*/
pub fn new_int() -> Self {
let base = malloc!(i32, CELL_MAXID + c::SPICE_CELL_CTRLSZ as usize);
Self(CELL {
dtype: c::_SpiceDataType_SPICE_INT,
length: 0i32,
size: CELL_MAXID as i32,
card: 0i32,
isSet: 1i32,
adjust: 0i32,
init: 0i32,
base: base as *mut libc::c_void,
data: base.wrapping_add(c::SPICE_CELL_CTRLSZ as usize) as *mut libc::c_void,
})
}
/**
Declare data from a cell at index.
*/
pub fn get_data_int(&self, index: usize) -> i32 {
unsafe { *(self.data as *mut i32).wrapping_add(index) }
}
}
impl Deref for Cell {
type Target = c::SpiceCell;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for Cell {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
cspice_proc! {
/**
Translate the SPICE integer code of a body into a common name for that body.
This function has a [neat version][crate::neat::bodc2n].
*/
pub fn bodc2n(code: i32, lenout: i32) -> (String, bool) {}
}
cspice_proc! {
/**
Determine whether values exist for some item for any body in the kernel pool.
*/
#[return_output]
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn bodfnd(body: i32, item: &str) -> bool {}
}
cspice_proc! {
/**
Translate the name of a body or object to the corresponding SPICE integer ID code.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn bodn2c(name: &str) -> (i32, bool) {}
}
/**
Fetch from the kernel pool the double precision values of an item associated with a body.
*/
pub fn bodvrd(bodynm: &str, item: &str, maxn: usize) -> Vec<f64> {
let bodynm = cstr!(bodynm);
let item = cstr!(item);
let mut dim = 0;
let mut values = vec![0.0; maxn];
unsafe { crate::c::bodvrd_c(bodynm, item, maxn as _, &mut dim, values.as_mut_ptr()) };
values.truncate(dim as _);
values
}
cspice_proc! {
/**
close a das file.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn dascls(handle: i32) {}
}
cspice_proc! {
/**
Open a DAS file for reading.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn dasopr(fname: &str) -> i32 {}
}
/**
Return the value of Delta ET (ET-UTC) for an input epoch.
*/
pub fn deltet(epoch: f64, eptype: &str) -> f64 {
let eptype = cstr!(eptype);
let mut delta = 0.0;
unsafe {
crate::c::deltet_c(epoch, eptype, &mut delta);
}
delta
}
cspice_proc! {
/**
Begin a forward segment search in a DLA file.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn dlabfs(handle: i32) -> (DLADSC, bool) {}
}
cspice_proc! {
/**
Return the DSK descriptor from a DSK segment identified by a DAS handle and DLA descriptor.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn dskgd(handle: i32, dladsc: DLADSC) -> DSKDSC {}
}
cspice_proc! {
/**
Compute the unit normal vector for a specified plate from a type 2 DSK segment.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn dskn02(handle: i32, dladsc: DLADSC, plid: i32) -> [f64; 3] {}
}
cspice_proc! {
/**
Find the set of body ID codes of all objects for which topographic data are provided in a
specified DSK file.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn dskobj(dsk: &str) -> Cell {}
}
/**
Fetch triangular plates from a type 2 DSK segment.
This function has a [neat version][crate::neat::dskp02].
*/
pub fn dskp02(handle: i32, mut dladsc: DLADSC, start: i32, room: i32) -> (i32, Vec<[i32; 3]>) {
let mut varout_0 = init_scalar!();
let varout_1 = malloc!([i32; 3], room);
unsafe {
crate::c::dskp02_c(handle, &mut dladsc, start, room, mptr!(varout_0), varout_1);
(
get_scalar!(varout_0),
get_varr!(varout_1, get_scalar!(varout_0)),
)
}
}
/**
Fetch vertices from a type 2 DSK segment.
This function has a [neat version][crate::neat::dskv02].
*/
pub fn dskv02(handle: i32, mut dladsc: DLADSC, start: i32, room: i32) -> (i32, Vec<[f64; 3]>) {
let mut varout_0 = init_scalar!();
let varout_1 = malloc!([f64; 3], room);
unsafe {
crate::c::dskv02_c(handle, &mut dladsc, start, room, mptr!(varout_0), varout_1);
(
get_scalar!(varout_0),
get_varr!(varout_1, get_scalar!(varout_0)),
)
}
}
cspice_proc! {
/**
Determine the plate ID and body-fixed coordinates of the intersection of a specified ray with
the surface defined by a type 2 DSK plate model.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn dskx02(
handle: i32,
dladsc: DLADSC,
vertex: [f64; 3],
raydir: [f64; 3]
) -> (i32, [f64; 3], bool) {
}
}
cspice_proc! {
/**
Return plate model size parameters---plate count and vertex count---for a type 2 DSK segment.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn dskz02(handle: i32, dladsc: DLADSC) -> (i32, i32) {}
}
/**
Return the d.p. value of a kernel variable from the kernel pool.
*/
pub fn gdpool(name: &str, start: usize, room: usize) -> Vec<f64> {
let name = cstr!(name);
let start = start as _;
let mut n = 0;
let mut values = vec![0.0; room];
let mut found = 0;
unsafe {
crate::c::gdpool_c(
name,
start,
room as _,
&mut n,
values.as_mut_ptr(),
&mut found,
)
}
// let found = found != 0;
values.truncate(n as _);
values
}
cspice_proc! {
/**
Convert geodetic coordinates to rectangular coordinates.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn georec(lon: f64, lat: f64, alt: f64, re: f64, f: f64) -> [f64; 3] {}
}
cspice_proc! {
/**
Compute the illumination angles---phase, incidence, and emission---at a specified point on a
target body. Return logical flags indicating whether the surface point is visible from the
observer's position and whether the surface point is illuminated.
The target body's surface is represented using topographic data provided by DSK files, or by a
reference ellipsoid.
The illumination source is a specified ephemeris object.
*/
#[allow(clippy::too_many_arguments)]
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn illumf(
method: &str,
target: &str,
ilusrc: &str,
et: f64,
fixref: &str,
abcorr: &str,
obsrvr: &str,
spoint: [f64; 3]
) -> (f64, [f64; 3], f64, f64, f64, bool, bool) {}
}
cspice_proc! {
/**
Load one or more SPICE kernels into a program.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn furnsh(name: &str) {}
}
cspice_proc! {
/**
Clear the KEEPER subsystem: unload all kernels, clear the kernel pool, and re-initialize the
subsystem. Existing watches on kernel variables are retained.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn kclear() {}
}
/**
Fetch vertices from a type 2 DSK segment.
This function has a [neat version][crate::neat::kdata].
*/
pub fn kdata(
which: i32,
kind: &str,
fillen: i32,
typlen: i32,
srclen: i32,
) -> (String, String, String, i32, bool) {
#[allow(unused_unsafe)]
unsafe {
let varout_0 = mallocstr!(fillen);
let varout_1 = mallocstr!(typlen);
let varout_2 = mallocstr!(srclen);
let mut varout_3 = 0i32;
let mut varout_4 = 0i32;
crate::c::kdata_c(
which,
cstr!(kind),
fillen,
typlen,
srclen,
varout_0,
varout_1,
varout_2,
&mut varout_3,
&mut varout_4,
);
(
fcstr!(varout_0),
fcstr!(varout_1),
fcstr!(varout_2),
varout_3,
varout_4 != 0,
)
}
}
cspice_proc! {
/**
Return the current number of kernels that have been loaded via the KEEPER interface that are of
a specified type.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn ktotal(kind: &str) -> i32 {}
}
cspice_proc! {
/**
Convert from latitudinal coordinates to rectangular coordinates.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn latrec(radius: f64, longitude: f64, latitude: f64) -> [f64; 3] {}
}
cspice_proc! {
/**
Multiply a 3x3 double precision matrix with a 3-dimensional double precision vector.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn mxv(m1: [[f64; 3]; 3], vin: [f64; 3]) -> [f64; 3] {}
}
cspice_proc! {
/**
Determines the occultation condition (not occulted, partially, etc.) of one target relative to
another target as seen by an observer at a given time, with targets modeled as points,
ellipsoids, or digital shapes (DSK)
*/
#[allow(clippy::too_many_arguments)]
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn occult(
targ1: &str,
shape1: &str,
frame1: &str,
targ2: &str,
shape2: &str,
frame2: &str,
abcorr: &str,
obsrvr: &str,
et: f64,
) -> i32 {}
}
cspice_proc! {
/**
Return the matrix that transforms position vectors from one specified frame to another at a
specified epoch.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn pxform(from: &str, to: &str, et: f64) -> [[f64; 3]; 3] {}
}
cspice_proc! {
/**
Return the 3x3 matrix that transforms position vectors from one specified frame at a specified
epoch to another specified frame at another specified epoch.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn pxfrm2(from: &str, to: &str, etfrom: f64, etto: f64) -> [[f64; 3]; 3] {}
}
cspice_proc! {
/**
Convert range, right ascension, and declination to rectangular coordinates
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn radrec(range: f64, ra: f64, dec: f64) -> [f64; 3] {}
}
/**
Convert rectangular coordinates to planetographic coordinates.
*/
pub fn recpgr(body: &str, rectan: [f64; 3], re: f64, f: f64) -> [f64; 3] {
let body = cstr!(body);
let mut rectan: [f64; 3] = rectan;
let mut lon = 0.0;
let mut lat = 0.0;
let mut alt = 0.0;
unsafe { crate::c::recpgr_c(body, &mut rectan as _, re, f, &mut lon, &mut lat, &mut alt) };
[lon, lat, alt]
}
cspice_proc! {
/**
Convert rectangular coordinates to range, right ascension, and declination.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn recrad(rectan: [f64; 3]) -> (f64, f64, f64) {}
}
cspice_proc! {
/**
Close a SPK file opened for read or write.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn spkcls(handle: i32) {}
}
cspice_proc! {
/**
Create a new SPK file, returning the handle of the opened file
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn spkopn(fname: &str, ifname: &str, ncomch: i32) -> i32 {}
}
cspice_proc! {
/**
Write a type 9 segment to an SPK file.
*/
#[allow(clippy::too_many_arguments)]
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn spkw09(handle: i32, body: i32, center: i32, frame: &str, first: f64, last: f64, segid: &str, degree: i32, n: i32, states: &mut [[f64; 6]], epochs: &mut [f64]) {}
}
cspice_proc! {
/**
Return the position of a target body relative to an observing body, optionally corrected for
light time (planetary aberration) and stellar aberration.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn spkpos(targ: &str, et: f64, frame: &str, abcorr: &str, obs: &str) -> ([f64; 3], f64) {}
}
cspice_proc! {
/**
Return the state (position and velocity) of a target body
relative to an observing body, optionally corrected for light
time (planetary aberration) and stellar aberration.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn spkezr(targ: &str, et: f64, frame: &str, abcorr: &str, obs: &str) -> ([f64; 6], f64) {}
}
cspice_proc! {
/**
Convert a string representing an epoch to a double precision value representing the number of
TDB seconds past the J2000 epoch corresponding to the input epoch.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn str2et(targ: &str) -> f64 {}
}
/**
Compute the rectangular coordinates of the sub-observer point on
a target body at a specified epoch, optionally corrected for
light time and stellar aberration.
The surface of the target body may be represented by a triaxial
ellipsoid or by topographic data provided by DSK files.
*/
pub fn subpnt(
method: &str,
target: &str,
et: f64,
fixref: &str,
abcorr: &str,
obsrvr: &str,
) -> ([f64; 3], f64, [f64; 3]) {
let method = cstr!(method);
let target = cstr!(target);
let fixref = cstr!(fixref);
let abcorr = cstr!(abcorr);
let obsrvr = cstr!(obsrvr);
let mut sp = [0.0; 3];
let mut et_sp = 0.0;
let mut vec_sp = [0.0; 3];
unsafe {
crate::c::subpnt_c(
method,
target,
et,
fixref,
abcorr,
obsrvr,
&mut sp as _,
&mut et_sp,
&mut vec_sp as _,
)
};
(sp, et_sp, vec_sp)
}
/**
Convert an input epoch represented in TDB seconds past the TDB epoch of J2000 to a character string formatted to the
specifications of a user's format picture.
This function has a [neat version][crate::neat::timout].
*/
pub fn timout(et: f64, pictur: &str, lenout: usize) -> String {
let varout_0 = mallocstr!(lenout);
unsafe {
crate::c::timout_c(et, cstr!(pictur), lenout as i32, varout_0);
}
fcstr!(varout_0)
}
/**
Transform time from one uniform scale to another. The uniform time scales are
TAI, GPS, TT, TDT, TDB, ET, JED, JDTDB, JDTDT.
*/
pub fn unitim(epoch: f64, insys: &str, outsys: &str) -> f64 {
let insys = cstr!(insys);
let outsys = cstr!(outsys);
unsafe { crate::c::unitim_c(epoch, insys, outsys) }
}
cspice_proc! {
/**
Unload a SPICE kernel.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn unload(name: &str) {}
}
cspice_proc! {
/**
Find the separation angle in radians between two double precision, 3-dimensional vectors. This
angle is defined as zero if either vector is zero.
*/
#[return_output]
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn vsep(v1: [f64; 3], v2: [f64; 3]) -> f64 {}
}
cspice_proc! {
/**
Compute the dot product of two double precision, 3-dimensional vectors.
*/
#[return_output]
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn vdot(v1: [f64; 3], v2: [f64; 3]) -> f64 {}
}
cspice_proc! {
/**
Compute the cross product of two 3-dimensional vectors.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn vcrss(v1: [f64; 3], v2: [f64; 3]) -> [f64; 3] {}
}
cspice_proc! {
/**
Transpose a 3x3 matrix.
*/
#[cfg_attr(any(feature = "lock", doc), impl_for(SpiceLock))]
pub fn xpose(m1: [[f64; 3]; 3]) -> [[f64; 3]; 3] {}
}