F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Public Member Functions | List of all members
Fw::SetOrMapImplEntry< KE, VN > Class Template Referencefinal

#include <Fw/DataStructures/SetOrMapImplEntry.hpp>

Inheritance diagram for Fw::SetOrMapImplEntry< KE, VN >:
Fw::MapEntryBase< KE, VN >

Public Member Functions

 SetOrMapImplEntry ()
 Zero-argument constructor. More...
 
 SetOrMapImplEntry (const KE &keyOrElement, const VN &valueOrNil)
 Constructor providing members. More...
 
 SetOrMapImplEntry (const SetOrMapImplEntry< KE, VN > &entry)
 Copy constructor. More...
 
 ~SetOrMapImplEntry () override=default
 Destructor. More...
 
SetOrMapImplEntry< KE, VN > & operator= (const SetOrMapImplEntry< KE, VN > &entry)
 operator= More...
 
const KE & getKeyOrElement () const
 
const VN & getValueOrNil () const
 
void setKeyOrElement (const KE &keyOrElement)
 Set the key or element. More...
 
void setValueOrNil (const VN &valueOrNil)
 Set the value or Nil. More...
 
const KE & getKey () const override
 
const VN & getValue () const override
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::MapEntryBase< KE, VN >
 MapEntryBase ()=default
 Zero-argument constructor. More...
 
virtual ~MapEntryBase ()=default
 Destructor. More...
 

Detailed Description

template<typename KE, typename VN>
class Fw::SetOrMapImplEntry< KE, VN >

Definition at line 16 of file SetOrMapImplEntry.hpp.

Constructor & Destructor Documentation

◆ SetOrMapImplEntry() [1/3]

template<typename KE, typename VN>
Fw::SetOrMapImplEntry< KE, VN >::SetOrMapImplEntry ( )
inline

Zero-argument constructor.

Definition at line 32 of file SetOrMapImplEntry.hpp.

◆ SetOrMapImplEntry() [2/3]

template<typename KE, typename VN>
Fw::SetOrMapImplEntry< KE, VN >::SetOrMapImplEntry ( const KE &  keyOrElement,
const VN &  valueOrNil 
)
inline

Constructor providing members.

Parameters
keyOrElementThe key or element
valueOrNilThe value or Nil

Definition at line 35 of file SetOrMapImplEntry.hpp.

◆ SetOrMapImplEntry() [3/3]

template<typename KE, typename VN>
Fw::SetOrMapImplEntry< KE, VN >::SetOrMapImplEntry ( const SetOrMapImplEntry< KE, VN > &  entry)
inline

Copy constructor.

Definition at line 41 of file SetOrMapImplEntry.hpp.

◆ ~SetOrMapImplEntry()

template<typename KE, typename VN>
Fw::SetOrMapImplEntry< KE, VN >::~SetOrMapImplEntry ( )
overridedefault

Destructor.

Member Function Documentation

◆ getKey()

template<typename KE, typename VN>
const KE& Fw::SetOrMapImplEntry< KE, VN >::getKey ( ) const
inlineoverridevirtual

Get the key associated with this entry

Returns
The key

Implements Fw::MapEntryBase< KE, VN >.

Definition at line 84 of file SetOrMapImplEntry.hpp.

◆ getKeyOrElement()

template<typename KE, typename VN>
const KE& Fw::SetOrMapImplEntry< KE, VN >::getKeyOrElement ( ) const
inline

Get the key or element associated with this entry

Returns
The key or element

Definition at line 62 of file SetOrMapImplEntry.hpp.

◆ getValue()

template<typename KE, typename VN>
const VN& Fw::SetOrMapImplEntry< KE, VN >::getValue ( ) const
inlineoverridevirtual

Get the value associated with this entry

Returns
The value

Implements Fw::MapEntryBase< KE, VN >.

Definition at line 88 of file SetOrMapImplEntry.hpp.

◆ getValueOrNil()

template<typename KE, typename VN>
const VN& Fw::SetOrMapImplEntry< KE, VN >::getValueOrNil ( ) const
inline

Get the value or nil associated with this entry

Returns
The value or nil

Definition at line 66 of file SetOrMapImplEntry.hpp.

◆ operator=()

template<typename KE, typename VN>
SetOrMapImplEntry<KE, VN>& Fw::SetOrMapImplEntry< KE, VN >::operator= ( const SetOrMapImplEntry< KE, VN > &  entry)
inline

operator=

Definition at line 52 of file SetOrMapImplEntry.hpp.

◆ setKeyOrElement()

template<typename KE, typename VN>
void Fw::SetOrMapImplEntry< KE, VN >::setKeyOrElement ( const KE &  keyOrElement)
inline

Set the key or element.

Parameters
keyOrElementThe key or element

Definition at line 69 of file SetOrMapImplEntry.hpp.

◆ setValueOrNil()

template<typename KE, typename VN>
void Fw::SetOrMapImplEntry< KE, VN >::setValueOrNil ( const VN &  valueOrNil)
inline

Set the value or Nil.

Definition at line 75 of file SetOrMapImplEntry.hpp.

The documentation for this class was generated from the following file: