Rose
Public Member Functions | Public Attributes | List of all members
rose::SatelliteMetaData Struct Reference
Collaboration diagram for rose::SatelliteMetaData:
Collaboration graph
[legend]

Public Member Functions

bool operator< (const SatelliteMetaData &other) const
 
void setPassData (bool riseOk, bool setOk, DateTime rise, DateTime set)
 Set the pass times for the Satellite. More...
 
std::tuple< bool, bool, DateTime, DateTimegetPassData () const
 Get the data relative to. More...
 
std::string passTimeString (time_t relative=0) const
 Create a std::string that describes the pass. More...
 

Public Attributes

std::string name
 
ImageId imageId
 
bool passRiseOk {}
 
bool passSetOk {}
 
DateTime riseTime {}
 
DateTime setTime {}
 
double elevation {}
 
double azimuth {}
 
double range {}
 
double rangeRate {}
 

Member Function Documentation

◆ getPassData()

std::tuple<bool, bool, DateTime, DateTime> rose::SatelliteMetaData::getPassData ( ) const
inline

Get the data relative to.

Returns

◆ passTimeString()

std::string rose::SatelliteMetaData::passTimeString ( time_t  relative = 0) const

Create a std::string that describes the pass.

If relative == 0 then times that are converted are converted to absolute dates and times in GMT. If the rise time is valid and in the future it is entered into the string first followed by " - " and the set time. If relative is not 0 the set time is converted relative to the rise time. This provides the rise time followed by the pass duration.

If the rise time is not valid only the set time is converted providing the set time if relative is 0 or the duration if relative is not 0.

Parameters
relativeA time_t to make the strings relative to.
Returns
a std::string with the formatted pass timing data.

◆ setPassData()

void rose::SatelliteMetaData::setPassData ( bool  riseOk,
bool  setOk,
DateTime  rise,
DateTime  set 
)
inline

Set the pass times for the Satellite.

Parameters
riseThe rise time.
setThe set time.

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