Class astrea::astro::Constellation::sat_iterator¶

ClassList > astrea > astro > Constellation > sat_iterator

Iterator class for iterating over all Spacecraft in theConstellation .

#include <Constellation.hpp>

Public Functions¶

Type	Name
bool	operator!= (const sat_iterator & other) const Inequality operator for the sat_iterator .
Spacecraft_T	operator* () Dereference operator for the sat_iterator .
sat_iterator &	operator++ () Pre-increment operator for the sat_iterator .
sat_iterator	operator++ (int) Post-increment operator for the sat_iterator .
sat_iterator &	operator-- () Pre-decrement operator for the sat_iterator .
sat_iterator	operator-- (int) Post-decrement operator for the sat_iterator .
bool	operator< (const sat_iterator & other) const Less than operator for the sat_iterator .
bool	operator<= (const sat_iterator & other) const Less than or equal to operator for the sat_iterator .
bool	operator== (const sat_iterator & other) const Equality operator for the sat_iterator .
bool	operator> (const sat_iterator & other) const Greater than operator for the sat_iterator .
bool	operator>= (const sat_iterator & other) const Greater than or equal to operator for the sat_iterator .
	sat_iterator (std::vector< Shell< Spacecraft_T >>::iterator _iterShell, Shell< Spacecraft_T >::sat_iterator _iterSat) Construct a sat_iterator from aShell iterator and aSpacecraft iterator.

Public Functions Documentation¶

function operator!=¶

Inequality operator for the sat_iterator .

inline bool astrea::astro::Constellation::sat_iterator::operator!= (
    const sat_iterator & other
) const

Parameters:

other The other sat_iterator to compare with.

Returns:

true if both iterators do not point to the same Spacecraft, false otherwise.

function operator*¶

Dereference operator for the sat_iterator .

inline Spacecraft_T astrea::astro::Constellation::sat_iterator::operator* ()

Returns:

Spacecraft_T& A reference to the Spacecraft pointed to by the iterator.

function operator++¶

Pre-increment operator for the sat_iterator .

inline sat_iterator & astrea::astro::Constellation::sat_iterator::operator++ ()

Returns:

sat_iterator& A reference to the incremented iterator.

function operator++¶

Post-increment operator for the sat_iterator .

inline sat_iterator astrea::astro::Constellation::sat_iterator::operator++ (
    int
)

Returns:

sat_iterator A copy of the iterator before incrementing.

function operator--¶

Pre-decrement operator for the sat_iterator .

inline sat_iterator & astrea::astro::Constellation::sat_iterator::operator-- ()

Returns:

sat_iterator& A reference to the decremented iterator.

function operator--¶

Post-decrement operator for the sat_iterator .

inline sat_iterator astrea::astro::Constellation::sat_iterator::operator-- (
    int
)

Returns:

sat_iterator A copy of the iterator before decrementing.

function operator<¶

Less than operator for the sat_iterator .

inline bool astrea::astro::Constellation::sat_iterator::operator< (
    const sat_iterator & other
) const

Parameters:

other The other sat_iterator to compare with.

Returns:

true if this iterator is less than the other, false otherwise.

Returns:

false if this iterator is greater than or equal to the other.

function operator<=¶

Less than or equal to operator for the sat_iterator .

inline bool astrea::astro::Constellation::sat_iterator::operator<= (
    const sat_iterator & other
) const

Parameters:

other The other sat_iterator to compare with.

Returns:

true if this iterator is less than or equal to the other, false otherwise.

Returns:

false if this iterator is greater than the other.

function operator==¶

Equality operator for the sat_iterator .

inline bool astrea::astro::Constellation::sat_iterator::operator== (
    const sat_iterator & other
) const

Parameters:

other The other sat_iterator to compare with.

Returns:

true if both iterators point to the same Spacecraft, false otherwise.

function operator>¶

Greater than operator for the sat_iterator .

inline bool astrea::astro::Constellation::sat_iterator::operator> (
    const sat_iterator & other
) const

Parameters:

other The other sat_iterator to compare with.

Returns:

true if this iterator is greater than the other, false otherwise.

Returns:

false if this iterator is less than or equal to the other.

function operator>=¶

Greater than or equal to operator for the sat_iterator .

inline bool astrea::astro::Constellation::sat_iterator::operator>= (
    const sat_iterator & other
) const

Parameters:

other The other sat_iterator to compare with.

Returns:

true if this iterator is greater than or equal to the other, false otherwise.

Returns:

false if this iterator is less than the other.

function sat_iterator¶

Construct a sat_iterator from aShell iterator and aSpacecraft iterator.

inline astrea::astro::Constellation::sat_iterator::sat_iterator (
    std::vector< Shell < Spacecraft_T >>:: iterator _iterShell,
    Shell < Spacecraft_T >:: sat_iterator _iterSat
)

Parameters:

_iterShell The iterator for the Shells in the Constellation.
_iterSat The iterator for the Spacecraft within the current Shell.

The documentation for this class was generated from the following file astrea/astro/astro/platforms/space/Constellation.hpp