Class astrea::trace::GroundArchitecture

ClassList > astrea > trace > GroundArchitecture

GroundArchitecture class represents a collection of ground stations.More...

• #include <GroundArchitecture.hpp>

Public Types

Type	Name
typedef std::vector< GroundStation >::const_iterator	const_iterator Constant iterator type for the GroundArchitecture class.
typedef std::vector< GroundStation >::iterator	iterator Iterator type for the GroundArchitecture class.

Public Functions

Type	Name
	GroundArchitecture (const std::vector< GroundStation > & groundStations) Constructs a GroundArchitecture with a list of ground stations.
iterator	begin () Returns an iterator to the beginning of the ground stations.
const_iterator	begin () const Returns a constant iterator to the beginning of the ground stations.
const_iterator	cbegin () const Returns a constant iterator to the beginning of the ground stations.
const_iterator	cend () const Returns a constant iterator to the end of the ground stations.
iterator	end () Returns an iterator to the end of the ground stations.
const_iterator	end () const Returns a constant iterator to the end of the ground stations.
GroundStation &	operator[] (const std::size_t & idx) Access operator for GroundStation .
const GroundStation &	operator[] (const std::size_t & idx) const Access operator for GroundStation (const).
std::size_t	size () const Returns the number of ground stations in the architecture.
	~GroundArchitecture () = default Default destructor for GroundArchitecture .

Detailed Description

This class is used to manage and access a set of ground stations, which can be used for various purposes such as communication, observation, or data collection.

Public Types Documentation

typedef const_iterator

Constant iterator type for the GroundArchitecture class.

using astrea::trace::GroundArchitecture::const_iterator =  std::vector<GroundStation>::const_iterator;

---

typedef iterator

Iterator type for the GroundArchitecture class.

using astrea::trace::GroundArchitecture::iterator =  std::vector<GroundStation>::iterator;

---

Public Functions Documentation

function GroundArchitecture

Constructs a GroundArchitecture with a list of ground stations.

inline astrea::trace::GroundArchitecture::GroundArchitecture (
    const std::vector< GroundStation > & groundStations
) 

Parameters:

• groundStations A vector of GroundStation objects representing the ground stations.

---

function begin [1/2]

Returns an iterator to the beginning of the ground stations.

inline iterator astrea::trace::GroundArchitecture::begin () 

Returns:

An iterator to the first ground station.

---

function begin [2/2]

Returns a constant iterator to the beginning of the ground stations.

inline const_iterator astrea::trace::GroundArchitecture::begin () const

Returns:

A constant iterator to the first ground station.

---

function cbegin

Returns a constant iterator to the beginning of the ground stations.

inline const_iterator astrea::trace::GroundArchitecture::cbegin () const

Returns:

A constant iterator to the first ground station.

---

function cend

Returns a constant iterator to the end of the ground stations.

inline const_iterator astrea::trace::GroundArchitecture::cend () const

Returns:

A constant iterator to one past the last ground station.

---

function end [1/2]

Returns an iterator to the end of the ground stations.

inline iterator astrea::trace::GroundArchitecture::end () 

Returns:

An iterator to one past the last ground station.

---

function end [2/2]

Returns a constant iterator to the end of the ground stations.

inline const_iterator astrea::trace::GroundArchitecture::end () const

Returns:

A constant iterator to one past the last ground station.

---

function operator[]

Access operator for GroundStation .

inline GroundStation & astrea::trace::GroundArchitecture::operator[] (
    const std::size_t & idx
) 

Parameters:

• idx The index of the ground station to access.

Returns:

GroundStation& Ground station at the specified index.

---

function operator[]

Access operator for GroundStation (const).

inline const GroundStation & astrea::trace::GroundArchitecture::operator[] (
    const std::size_t & idx
) const

Parameters:

• idx The index of the ground station to access.

Returns:

const GroundStation& Ground station at the specified index.

---

function size

Returns the number of ground stations in the architecture.

inline std::size_t astrea::trace::GroundArchitecture::size () const

Returns:

std::size_t The number of ground stations.

---

function ~GroundArchitecture

Default destructor for GroundArchitecture .

astrea::trace::GroundArchitecture::~GroundArchitecture () = default

---

---

The documentation for this class was generated from the following file astrea/trace/trace/platforms/ground/GroundArchitecture.hpp