Back to Fprime

SetEntry

Fw/DataStructures/docs/SetEntry.md

4.2.21.1 KB
Original Source

SetEntry

SetEntry is an abstract class template defined in Fw/DataStructures. It represents an iterator for a set.

1. Template Parameters

SetEntry has the following template parameters.

KindNamePurpose
typenameTThe type of an element in the set

2. Private Constructors and Destructors

2.1. Copy Constructor

c++
SetEntry(const SetEntry<T>& set)

Defined as = delete.

3. Protected Constructors and Destructors

3.1. Zero-Argument Constructor

c++
SetEntry()

Use default initialization of members.

3.2. Destructor

c++
virtual ~SetEntry()

Defined as = default.

4. Private Member Functions

4.1. operator=

c++
SetEntry& operator=(const SetEntry<T>& setEntry)

Defined as = delete.

5. Public Member Functions

5.1. getElement

c++
virtual const T& getElement() const = 0

Return a reference to the set element stored in the iterator.

5.2. getNextSetEntry

c++
virtual const SetEntry<T>* getNextSetEntry() = 0

Return a pointer to the next iterator for the set, or nullptr if there is none.