PCL
pcl::EphemerisObject Struct Reference

Identifiers and descriptive data of an object available in an ephemeris file. More...

#include <EphemerisFile.h>

Public Member Functions

 EphemerisObject (const IsoString &objectId_, const IsoString &originId_, const String &objectName_=String(), const String &objectDescription_=String(), Optional< double > H_=Optional< double >(), Optional< double > G_=Optional< double >(), Optional< double > B_V_=Optional< double >(), Optional< double > D_=Optional< double >())
 
 EphemerisObject (const EphemerisObject &)=default
 
 EphemerisObject (EphemerisObject &&)=default
 
EphemerisObjectoperator= (const EphemerisObject &)=default
 
EphemerisObjectoperator= (EphemerisObject &&)=default
 

Public Attributes

Optional< double > B_V
 
Optional< double > D
 
Optional< double > G
 
Optional< double > H
 
String objectDescription
 
IsoString objectId
 
String objectName
 
IsoString originId
 

Detailed Description

This structure associates the unique identifier, origin identifier, name and description of an object or item available for ephemeris calculations. All of the data members in this structure are specific to a particular ephemeris file. A dynamic list of EphemerisObject instances (EphemerisObjectList) is returned by the EphemerisFile::Objects() member function.

See also
EphemerisFile::Objects()

Definition at line 451 of file EphemerisFile.h.

Constructor & Destructor Documentation

◆ EphemerisObject() [1/3]

pcl::EphemerisObject::EphemerisObject ( const IsoString objectId_,
const IsoString originId_,
const String objectName_ = String(),
const String objectDescription_ = String(),
Optional< double >  H_ = Optional<double>(),
Optional< double >  G_ = Optional<double>(),
Optional< double >  B_V_ = Optional<double>(),
Optional< double >  D_ = Optional<double>() 
)
inline

Memberwise constructor.

Definition at line 525 of file EphemerisFile.h.

◆ EphemerisObject() [2/3]

pcl::EphemerisObject::EphemerisObject ( const EphemerisObject )
default

Copy constructor.

◆ EphemerisObject() [3/3]

pcl::EphemerisObject::EphemerisObject ( EphemerisObject &&  )
default

Move constructor.

Member Function Documentation

◆ operator=() [1/2]

EphemerisObject& pcl::EphemerisObject::operator= ( const EphemerisObject )
default

Copy assignment operator. Returns a reference to this object.

◆ operator=() [2/2]

EphemerisObject& pcl::EphemerisObject::operator= ( EphemerisObject &&  )
default

Move assignment operator. Returns a reference to this object.

Member Data Documentation

◆ B_V

Optional<double> pcl::EphemerisObject::B_V

Color index B-V in magnitudes.

Definition at line 515 of file EphemerisFile.h.

◆ D

Optional<double> pcl::EphemerisObject::D

Diameter of the object in km.

Definition at line 520 of file EphemerisFile.h.

◆ G

Optional<double> pcl::EphemerisObject::G

Slope parameter. See the H data member for references.

Definition at line 510 of file EphemerisFile.h.

◆ H

Optional<double> pcl::EphemerisObject::H

Absolute magnitude. H is the visual magnitude of the object as seen at 1 au of the Earth, 1 au from the Sun, and with a phase angle of 0 degrees.

References

E. Bowell et al., Asteroids II, R. P. Binzel et al. (eds.), The University of Arizona Press, Tucson, 1989, pp. 549-554.

Urban, Sean E., Kenneth Seidelmann, P., ed. (2013), The Explanatory Supplement to the Astronomical Almanac 3rd Edition, Section 10.4.3.

Definition at line 505 of file EphemerisFile.h.

◆ objectDescription

String pcl::EphemerisObject::objectDescription

Optional information about the object and/or the ephemeris data.

Definition at line 491 of file EphemerisFile.h.

◆ objectId

IsoString pcl::EphemerisObject::objectId

Unique identifier of an object or item for which ephemeris data are available. This is a short string that uniquely identifies the object in the context of an ephemeris file.

For example, standard XEPH files serializing JPL DE/LE ephemerides use a two/three letter convention for object identifiers: 'Me', 'Ve', 'EMB', 'Ea', 'Ma', etc, respectively for Mercury, Venus, Earth-Moon barycenter, Earth, Mars, etc. Object identifiers are considered as case-sensitive in XEPH files.

Definition at line 464 of file EphemerisFile.h.

◆ objectName

String pcl::EphemerisObject::objectName

Optional Name of the object or item for which ephemeris data are available. This can be an arbitrary string, such as 'Saturn', 'Iris', or 'C/1996 B2'. Object names are considered as case-insensitive in XEPH files, so all of 'Jupiter', 'jupiter' and 'JUPITER' are equivalent.

Definition at line 486 of file EphemerisFile.h.

◆ originId

IsoString pcl::EphemerisObject::originId

Identifier of the origin of coordinates (case-sensitive). This can be the unique identifier of a solar system object, or the identifier of an arbitrary object or location, specific to a particular ephemeris file.

For example, if the object provides geocentric coordinates, this member should be "Ea", which is the unique identifier of the Earth's center in standard fundamental ephemerides files. Similarly, if the ephemerides are heliocentric, this member should be "Sn". If the ephemeris data are with respect to the solar system barycenter, this member must be "SSB", also for coherence with fundamental ephemerides.

Definition at line 478 of file EphemerisFile.h.


The documentation for this struct was generated from the following file: