Class astrea::astro::Shell::sat_iterator¶

ClassList > astrea > astro > Shell > sat_iterator

Iterator for iterating over all Spacecraft in theShell .

#include <Shell.hpp>

Public Types¶

Type	Name
typedef Plane< Spacecraft_T >::iterator	difference_type
typedef std::forward_iterator_tag	iterator_category
typedef const Plane< Spacecraft_T >::iterator *	pointer
typedef const Plane< Spacecraft_T >::iterator &	reference
typedef Plane< Spacecraft_T >::iterator	value_type

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++ () Increment operator for the sat_iterator .
sat_iterator	operator++ (int) Post-increment operator for the sat_iterator .
sat_iterator &	operator-- () 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 Comparison operators 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< Plane< Spacecraft_T >>::iterator _iterPlane, Plane< Spacecraft_T >::iterator _iterSat) Default constructor for sat_iterator . Initializes the iterator to the beginning of the first plane's spacecraft.

Public Types Documentation¶

typedef difference_type¶

using astrea::astro::Shell< Spacecraft_T >::sat_iterator::difference_type =  Plane<Spacecraft_T>::iterator;

typedef iterator_category¶

using astrea::astro::Shell< Spacecraft_T >::sat_iterator::iterator_category =  std::forward_iterator_tag;

typedef pointer¶

using astrea::astro::Shell< Spacecraft_T >::sat_iterator::pointer =  const Plane<Spacecraft_T>::iterator*;

typedef reference¶

using astrea::astro::Shell< Spacecraft_T >::sat_iterator::reference =  const Plane<Spacecraft_T>::iterator&;

typedef value_type¶

using astrea::astro::Shell< Spacecraft_T >::sat_iterator::value_type =  Plane<Spacecraft_T>::iterator;

Public Functions Documentation¶

function operator!=¶

Inequality operator for the sat_iterator .

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

Parameters:

other The other iterator to compare against.

Returns:

bool True if the iterators are not equal, false otherwise.

function operator*¶

Dereference operator for the sat_iterator .

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

Returns:

Spacecraft_T& A reference to the spacecraft at the current iterator position.

function operator++¶

Increment operator for the sat_iterator .

inline sat_iterator & astrea::astro::Shell::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::Shell::sat_iterator::operator++ (
    int
)

Returns:

sat_iterator A copy of the iterator before incrementing.

function operator--¶

Decrement operator for the sat_iterator .

inline sat_iterator & astrea::astro::Shell::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::Shell::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::Shell::sat_iterator::operator< (
    const sat_iterator & other
) const

Parameters:

other The other iterator to compare against.

Returns:

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

Returns:

false if this iterator is not less than the other.

function operator<=¶

Less than or equal to operator for the sat_iterator .

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

Parameters:

other The other iterator to compare against.

Returns:

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

Returns:

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

function operator==¶

Comparison operators for the sat_iterator .

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

Parameters:

other The other iterator to compare against.

Returns:

bool True if the iterators are equal, false otherwise.

function operator>¶

Greater than operator for the sat_iterator .

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

Parameters:

other The other iterator to compare against.

Returns:

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

Returns:

false if this iterator is not greater than the other.

function operator>=¶

Greater than or equal to operator for the sat_iterator .

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

Parameters:

other The other iterator to compare against.

Returns:

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

Returns:

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

function sat_iterator¶

Default constructor for sat_iterator . Initializes the iterator to the beginning of the first plane's spacecraft.

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

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