Skip to content

Commit

Permalink
chore: fix doxygen formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@vishwa2710
vishwa2710 committed Dec 1, 2023
1 parent ab8fa73 commit d7526c8
Show file tree
Hide file tree
Showing 57 changed files with 1,698 additions and 2,278 deletions.
3 changes: 1 addition & 2 deletions include/OpenSpaceToolkit/Astrodynamics/Access.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ using ostk::physics::time::Interval;

using ostk::physics::units::Angle;

/// @brief Object-to-object visibility

/// @brief Object-to-object visibility
class Access
{
public:
Expand Down
24 changes: 11 additions & 13 deletions include/OpenSpaceToolkit/Astrodynamics/Access/Generator.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,28 +101,26 @@ class Generator

static Generator Undefined();

/// @brief Constructs an access generator with defined AER ranges
/// @brief Constructs an access generator with defined AER ranges
///
/// @param [in] anAzimuthRange An azimuth interval [deg]
/// @param [in] anElevationRange An elevation interval [deg]
/// @param [in] aRangeRange A range interval [m]
/// @param [in] anEnvironment An environment
/// @return An access generator

/// @param anAzimuthRange An azimuth interval [deg]
/// @param anElevationRange An elevation interval [deg]
/// @param aRangeRange A range interval [m]
/// @param anEnvironment An environment
/// @return An access generator
static Generator AerRanges(
const Interval<Real>& anAzimuthRange,
const Interval<Real>& anElevationRange,
const Interval<Real>& aRangeRange,
const Environment& anEnvironment
);

/// @brief Constructs an access generator with a defined AER mask
/// @brief Constructs an access generator with a defined AER mask
///
/// @param [in] anAzimuthElevationMask An azimuth-elevation mask [deg]
/// @param [in] aRangeRange A range interval [m]
/// @param [in] anEnvironment An environment
/// @return An access generator

/// @param anAzimuthElevationMask An azimuth-elevation mask [deg]
/// @param aRangeRange A range interval [m]
/// @param anEnvironment An environment
/// @return An access generator
static Generator AerMask(
const Map<Real, Real>& anAzimuthElevationMask,
const Interval<Real>& aRangeRange,
Expand Down
17 changes: 8 additions & 9 deletions include/OpenSpaceToolkit/Astrodynamics/Conjunction/Messages/CCSDS/CDM.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,15 @@ using ostk::physics::units::Mass;

using ostk::astro::trajectory::State;

/// @brief CCSDS Conjunction Data Message (CDM)
/// @brief CCSDS Conjunction Data Message (CDM)
///
/// General content sections:
/// - Header
/// - Event Relative Metadata
/// - Objects Metadata
/// - Objects Data
/// General content sections:
/// - Header
/// - Event Relative Metadata
/// - Objects Metadata
/// - Objects Data
///
/// @ref https://public.ccsds.org/Pubs/508x0b1e2c2.pdf

/// @ref https://public.ccsds.org/Pubs/508x0b1e2c2.pdf
// TBI: Figure out how to adapt based on providers
// TBI: Find a good way to handle comments and extra fields
// TBI: Self-contained, create a RSO class to hold Object data
Expand Down Expand Up @@ -140,7 +139,7 @@ class CDM
String covarianceMethod;
String maneuverable;
String orbitCenter = String::Empty();
String refFrame; // TBI: Use Frame later
String refFrame; // TBI: Use Frame later
String gravityModel = String::Empty(); // TBI: Check String or actual pointer to GravityModel
String atmosphericModel = String::Empty();
String nBodyPerturbations = String::Empty();
Expand Down
78 changes: 33 additions & 45 deletions include/OpenSpaceToolkit/Astrodynamics/Dynamics.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ using ostk::astro::trajectory::state::NumericalSolver;
using ostk::astro::trajectory::state::CoordinatesBroker;
using ostk::astro::trajectory::state::CoordinatesSubset;

/// @brief Define a dynamical system subject to equations of motion

/// @brief Define a dynamical system subject to equations of motion
class Dynamics
{
public:
Expand All @@ -63,91 +62,80 @@ class Dynamics
Size readStateSize;
};

/// @brief Constructor
/// @brief Constructor
///
/// @param [in] aName A name

/// @param aName A name
Dynamics(const String& aName = String::Empty());

/// @brief Destructor

/// @brief Destructor
virtual ~Dynamics();

/// @brief Output stream operator
/// @brief Output stream operator
///
/// @code
/// std::cout << Dynamics(...) ;
/// std::cout << Dynamics(...) ;
/// @endcode
///
/// @param [in] anOutputStream An output stream
/// @param [in] aDynamics A Dynamics
/// @return A reference to output stream

/// @param anOutputStream An output stream
/// @param aDynamics A Dynamics
/// @return A reference to output stream
friend std::ostream& operator<<(std::ostream& anOutputStream, const Dynamics& aDynamics);

/// @brief Get name
/// @brief Get name
///
/// @return Name of Dynamics

/// @return Name of Dynamics
String getName() const;

/// @brief Print dynamics
/// @brief Print dynamics
///
/// @param [in] anOutputStream An output stream
/// @param [in] (optional) displayDecorators If true, display decorators

/// @param anOutputStream An output stream
/// @param (optional) displayDecorators If true, display decorators
virtual void print(std::ostream& anOutputStream, bool displayDecorator = true) const;

/// @brief Check if dynamics is defined (pure virtual)
/// @brief Check if dynamics is defined (pure virtual)
///
/// @return True if dynamics is defined

/// @return True if dynamics is defined
virtual bool isDefined() const = 0;

/// @brief Return the coordinates subsets that the instance reads from
/// @brief Return the coordinates subsets that the instance reads from
///
/// @return The coordinates subsets that the instance reads from

/// @return The coordinates subsets that the instance reads from
virtual Array<Shared<const CoordinatesSubset>> getReadCoordinatesSubsets() const = 0;

/// @brief Return the coordinates subsets that the instance writes to
/// @brief Return the coordinates subsets that the instance writes to
///
/// @return The coordinates subsets that the instance writes to

/// @return The coordinates subsets that the instance writes to
virtual Array<Shared<const CoordinatesSubset>> getWriteCoordinatesSubsets() const = 0;

/// @brief Compute the contribution to the state derivative.
/// @brief Compute the contribution to the state derivative.
///
/// @param [in] anInstant An instant
/// @param [in] x The reduced state vector (this vector will follow the structure determined by the
/// @param anInstant An instant
/// @param x The reduced state vector (this vector will follow the structure determined by the
/// 'read' coordinate subsets)
/// @param [in] aFrameSPtr The frame in which the state vector is expressed
/// @param aFrameSPtr The frame in which the state vector is expressed
///
/// @return The reduced derivative state vector (this vector must follow the structure determined by
/// @return The reduced derivative state vector (this vector must follow the structure determined by
/// the 'write' coordinate subsets) expressed in the given frame

virtual VectorXd computeContribution(
const Instant& anInstant, const VectorXd& x, const Shared<const Frame>& aFrameSPtr
) const = 0;

/// @brief Get system of equations wrapper
/// @brief Get system of equations wrapper
///
/// @param [in] aContextArray An array of Dynamics Information
/// @param [in] anInstant An instant
/// @param [in] aFrameSPtr The reference frame in which dynamic equations are resolved
/// @param aContextArray An array of Dynamics Information
/// @param anInstant An instant
/// @param aFrameSPtr The reference frame in which dynamic equations are resolved
///
/// @return std::function<void(const std::vector<double>&, std::vector<double>&, const double)>

/// @return std::function<void(const std::vector<double>&, std::vector<double>&, const double)>
static NumericalSolver::SystemOfEquationsWrapper GetSystemOfEquations(
const Array<Context>& aContextArray, const Instant& anInstant, const Shared<const Frame>& aFrameSPtr
);

/// @brief Get a list of dynamics from the envrionment
/// @brief Get a list of dynamics from the envrionment
///
/// @param [in] anEnvironment An environment
/// @param anEnvironment An environment
///
/// @return A list of dynamics

/// @return A list of dynamics
static Array<Shared<Dynamics>> FromEnvironment(const Environment& anEnvironment);

private:
Expand Down
69 changes: 29 additions & 40 deletions include/OpenSpaceToolkit/Astrodynamics/Dynamics/AtmosphericDrag.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,90 +29,79 @@ using ostk::physics::units::Mass;
using ostk::astro::Dynamics;
using ostk::astro::flight::system::SatelliteSystem;

/// @brief Define the acceleration experienced by a spacecraft due to atmospheric drag

/// @brief Define the acceleration experienced by a spacecraft due to atmospheric drag
class AtmosphericDrag : public Dynamics
{
public:
/// @brief Constructor
/// @brief Constructor
///
/// @code
/// const Celestial = { ... };
/// AtmosphericDrag atmosphericDrag = { aCelestial };
/// const Celestial = { ... };
/// AtmosphericDrag atmosphericDrag = { aCelestial };
/// @endcode
///
/// @param [in] aCelestial A celestial object

/// @param aCelestial A celestial object
AtmosphericDrag(const Shared<const Celestial>& aCelestial);

/// @brief Constructor
/// @brief Constructor
///
/// @code
/// const Celestial = { ... };
/// const aName = { ... };
/// AtmosphericDrag atmosphericDrag = { aCelestial, aName };
/// const Celestial = { ... };
/// const aName = { ... };
/// AtmosphericDrag atmosphericDrag = { aCelestial, aName };
/// @endcode
///
/// @param [in] aCelestial A celestial object
/// @param [in] aName A name

/// @param aCelestial A celestial object
/// @param aName A name
AtmosphericDrag(const Shared<const Celestial>& aCelestial, const String& aName);

/// @brief Destructor

/// @brief Destructor
virtual ~AtmosphericDrag() override;

/// @brief Output stream operator
/// @brief Output stream operator
///
/// @param [in] anOutputStream An output stream
/// @param [in] anAtmosphericDrag An atmospheric drag dynamics
/// @return A reference to output stream

/// @param anOutputStream An output stream
/// @param anAtmosphericDrag An atmospheric drag dynamics
/// @return A reference to output stream
friend std::ostream& operator<<(std::ostream& anOutputStream, const AtmosphericDrag& anAtmosphericDrag);

/// @brief Check if atmospheric drag dynamics is defined
/// @brief Check if atmospheric drag dynamics is defined
///
/// @return True if atmospheric drag dynamics is defined

/// @return True if atmospheric drag dynamics is defined
virtual bool isDefined() const override;

/// @brief Get celestial
/// @brief Get celestial
///
/// @return A celestial object

/// @return A celestial object
Shared<const Celestial> getCelestial() const;

/// @brief Return the coordinates subsets that the instance reads from
/// @brief Return the coordinates subsets that the instance reads from
///
/// @return The coordinates subsets that the instance reads from

/// @return The coordinates subsets that the instance reads from
virtual Array<Shared<const CoordinatesSubset>> getReadCoordinatesSubsets() const override;

/// @brief Return the coordinates subsets that the instance writes to
/// @brief Return the coordinates subsets that the instance writes to
///
/// @return The coordinates subsets that the instance writes to

/// @return The coordinates subsets that the instance writes to
virtual Array<Shared<const CoordinatesSubset>> getWriteCoordinatesSubsets() const override;

/// @brief Compute the contribution to the state derivative.
/// @brief Compute the contribution to the state derivative.
///
/// @param anInstant An instant
/// @param x The reduced state vector (this vector will follow the structure determined by the 'read'
/// coordinate subsets)
/// @param aFrameSPtr The frame in which the state vector is expressed
///
/// @return The reduced derivative state vector (this vector must follow the structure determined by
/// @return The reduced derivative state vector (this vector must follow the structure determined by
/// the 'write' coordinate subsets) expressed in the given frame

virtual VectorXd computeContribution(
const Instant& anInstant, const VectorXd& x, const Shared<const Frame>& aFrameSPtr
) const override;

/// @brief Print atmospheric drag dynamics
/// @brief Print atmospheric drag dynamics
///
/// @param [in] anOutputStream An output stream
/// @param [in] (optional) displayDecorators If true, display decorators

/// @param anOutputStream An output stream
/// @param (optional) displayDecorators If true, display decorators
virtual void print(std::ostream& anOutputStream, bool displayDecorator = true) const override;

private:
Expand Down
Loading

0 comments on commit d7526c8

Please sign in to comment.