DEIMOS
Earth Observation Mission CFI Software
Visibility Software User Manual		 ESA
Public Member Functions | Public Attributes

EECFI::OrbitExtra Class Reference

Class to extract orbital extra information. More...

Inheritance diagram for EECFI::OrbitExtra:
EECFI::ANXTime EECFI::CfiClass

List of all members.

Public Member Functions

 OrbitExtra ()
 Default constructor.
 OrbitExtra (const ANXTime &orbitInfo)
 Class constructor with parameters.
 OrbitExtra (const OrbitExtra &other)
 ~OrbitExtra () NOEXCEPT
 Class destructor.
OrbitExtra & operator= (const OrbitExtra &other)
void set (const ANXTime &orbitInfo)
 Set parameters.
OrbitExtraInfo orbitExtra (const std::vector< double > &sunZenitAngles) const
 It gets the orbital information related to Sun zenith angles and Sun occultations by the Earth and the Moon.

Public Attributes

OrbitalInfo orbitalInfo
 Orbital information (as returned from ANXTime::getOrbitInfo).

Detailed Description

Class to extract orbital extra information.

Constructor & Destructor Documentation

EECFI::OrbitExtra::OrbitExtra (  ) 

Default constructor.

If any calculation is going to be done, set method must be called first, in order to calculate the orbit information needed for calculations.

EECFI::OrbitExtra::OrbitExtra ( const ANXTime &  orbitInfo  )  [explicit]

Class constructor with parameters.

ANXTime is used to compute the orbit extra parameters needed, so it must have been initialised with OrbitId information.

Parameters:
orbitInfo ANXTime object used to calculate orbit information; it must have been initialised with OrbitId.
EECFI::OrbitExtra::OrbitExtra ( const OrbitExtra &  other  ) 

Copy constructor.

Parameters:
other The OrbitExtra to copy from
EECFI::OrbitExtra::~OrbitExtra (  ) 

Class destructor.

Member Function Documentation

OrbitExtra & EECFI::OrbitExtra::operator= ( const OrbitExtra &  other  ) 

Copy assigment operator.

Parameters:
other The OrbitExtra to copy/assign from

References orbitalInfo.

OrbitExtraInfo EECFI::OrbitExtra::orbitExtra ( const std::vector< double > &  sunZenitAngles  )  const

It gets the orbital information related to Sun zenith angles and Sun occultations by the Earth and the Moon.

This method computes for an input orbit, the times for:

  • an input set of Sun zenit angles are reached (both up and down times are computed)
  • Sun ocultations by the Earth.
  • Sun ocultations by the Moon.
Parameters:
sunZenitAngles List of sun zenit angles to compute [deg]. Allowed range: >=0; <=180.
Returns:
Orbit extra information.

References EECFI::OrbitalInfo::absOrbit, EECFI::CfiError::addMsg(), EECFI::OrbitalInfo::cycLength, EECFI::OrbitExtraInfo::eclipseEntry, EECFI::OrbitExtraInfo::eclipseExit, EECFI::OrbitalInfo::meanKep, EECFI::OrbitalInfo::mlst, EECFI::OrbitalInfo::mlstDrift, EECFI::OrbitalInfo::nodalPeriod, orbitalInfo, EECFI::OrbitalInfo::oscKep, EECFI::OrbitalInfo::phasing, EECFI::OrbitalInfo::posAnx, EECFI::OrbitalInfo::repCycle, EECFI::OrbitExtraInfo::sunMoonEntry, EECFI::OrbitExtraInfo::sunMoonExit, EECFI::OrbitExtraInfo::szaDown, EECFI::OrbitExtraInfo::szaUp, EECFI::CfiClass::throwWarn, EECFI::OrbitalInfo::utcAnx, and EECFI::OrbitalInfo::velAnx.

void EECFI::OrbitExtra::set ( const ANXTime &  orbitInfo  ) 

Set parameters.

ANXTime is used to compute the orbit extra parameters needed, so it must have been initialised with OrbitId information.

Parameters:
orbitInfo ANXTime object used to calculate orbit information; it must have been initialised with OrbitId.

References EECFI::CfiError::addMsg(), EECFI::ANXTime::getOrbitInfo(), EECFI::ANXTime::microseconds, EECFI::ANXTime::orbit, orbitalInfo, and EECFI::ANXTime::seconds.

Member Data Documentation

OrbitalInfo EECFI::OrbitExtra::orbitalInfo

Orbital information (as returned from ANXTime::getOrbitInfo).

Referenced by operator=(), orbitExtra(), and set().

Generated on Mon Dec 11 2023 13:28:33 for by doxygen 1.7.1