PCL
pcl::EphemerisConstant Struct Reference

A numerical constant defined in an ephemeris file (XEPH format). More...

#include <EphemerisFile.h>

Public Member Functions

 EphemerisConstant (const IsoString &n=IsoString(), double v=0)
 
 EphemerisConstant (const EphemerisConstant &)=default
 
 EphemerisConstant (EphemerisConstant &&)=default
 
bool operator< (const EphemerisConstant &x) const
 
EphemerisConstantoperator= (const EphemerisConstant &)=default
 
EphemerisConstantoperator= (EphemerisConstant &&)=default
 
bool operator== (const EphemerisConstant &x) const
 

Public Attributes

IsoString name
 The constant name (case-insensitive).
 
double value
 The constant value.
 

Detailed Description

This structure implements a simple name/value pair used to store and manipulate numerical constants defined in ephemeris files (current XEPH format version 1.0). These constants are primarily intended to support JPL DE/LE fundamental ephemerides, where we need access to the set of numerical integration constants defined by JPL.

Comparisons between EphemerisConstant instances are performed on the their names and are case-insensitive.

Definition at line 126 of file EphemerisFile.h.

Constructor & Destructor Documentation

◆ EphemerisConstant() [1/3]

pcl::EphemerisConstant::EphemerisConstant ( const IsoString n = IsoString(),
double  v = 0 
)
inline

Memberwise constructor.

Definition at line 134 of file EphemerisFile.h.

◆ EphemerisConstant() [2/3]

pcl::EphemerisConstant::EphemerisConstant ( const EphemerisConstant )
default

Copy constructor.

◆ EphemerisConstant() [3/3]

pcl::EphemerisConstant::EphemerisConstant ( EphemerisConstant &&  )
default

Move constructor.

Member Function Documentation

◆ operator<()

bool pcl::EphemerisConstant::operator< ( const EphemerisConstant x) const
inline

Less-than relational operator. Returns the result of the case-insensitive less-than operator applied to the name members of this object and the specified instance x.

Definition at line 173 of file EphemerisFile.h.

References pcl::GenericString< T, R, A >::CompareIC(), and name.

◆ operator=() [1/2]

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

Copy assignment operator. Returns a reference to this object.

◆ operator=() [2/2]

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

Move assignment operator. Returns a reference to this object.

◆ operator==()

bool pcl::EphemerisConstant::operator== ( const EphemerisConstant x) const
inline

Equality operator. Returns the result of the case-insensitive equality operator applied to the name members.

Definition at line 163 of file EphemerisFile.h.

References pcl::GenericString< T, R, A >::CompareIC(), and name.


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