F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
SdlsCfg::SaMap Class Reference

#include <Svc/Ccsds/SdlsSaRouter/config/SdlsSaRouterConfig/SaMapArrayAc.hpp>

Inheritance diagram for SdlsCfg::SaMap:
Fw::Serializable

Public Types

enum  { SIZE = 2, ELEMENT_SERIALIZED_SIZE = Svc::Ccsds::SaMapEntry::SERIALIZED_SIZE, SERIALIZED_SIZE = SIZE * ELEMENT_SERIALIZED_SIZE }
 
using ElementType = Svc::Ccsds::SaMapEntry
 The element type. More...
 
- Public Types inherited from Fw::Serializable
using SizeType = FwSizeType
 

Public Member Functions

 SaMap ()
 Constructor (default value) More...
 
 SaMap (const ElementType(&a)[SIZE])
 Constructor (primitive array) More...
 
 SaMap (const ElementType &e)
 Constructor (single element) More...
 
 SaMap (const std::initializer_list< ElementType > &il)
 Constructor (initializer list) More...
 
 SaMap (const SaMap &obj)
 Copy constructor. More...
 
ElementTypeoperator[] (const FwSizeType i)
 Subscript operator. More...
 
const ElementTypeoperator[] (const FwSizeType i) const
 Const subscript operator. More...
 
SaMapoperator= (const SaMap &obj)
 Copy assignment operator (object) More...
 
SaMapoperator= (const ElementType(&a)[SIZE])
 Copy assignment operator (primitive array) More...
 
SaMapoperator= (const std::initializer_list< ElementType > &il)
 Copy assignment operator (initializer list) More...
 
SaMapoperator= (const ElementType &e)
 Copy assignment operator (single element) More...
 
bool operator== (const SaMap &obj) const
 Equality operator. More...
 
bool operator!= (const SaMap &obj) const
 Inequality operator. More...
 
Fw::SerializeStatus serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
 Serialization. More...
 
Fw::SerializeStatus deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
 Deserialization. More...
 
FwSizeType serializedSize () const
 Get the dynamic serialized size of the array. More...
 
- Public Member Functions inherited from Fw::Serializable
 DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
 
 DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::Serializable
 Serializable ()
 Default constructor. More...
 
virtual ~Serializable ()
 Virtual destructor. More...
 

Detailed Description

Compile-time map from security association index to downstream port index. Projects may define sparse or non-linear SA ranges that map down to a compact, linear port array. Port indices must be in [0, SaRouterPortCount).

This default configuration maps SA 0 to the plain-text (no security) port; the second entry maps SA 1 to a port that standard topologies may leave unconnected.

Definition at line 26 of file SaMapArrayAc.hpp.

Member Typedef Documentation

◆ ElementType

The element type.

Definition at line 37 of file SaMapArrayAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SIZE 

The size of the array.

ELEMENT_SERIALIZED_SIZE 

The serialized size of each element.

SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 45 of file SaMapArrayAc.hpp.

Constructor & Destructor Documentation

◆ SaMap() [1/5]

SdlsCfg::SaMap::SaMap ( )

Constructor (default value)

Definition at line 17 of file SaMapArrayAc.cpp.

◆ SaMap() [2/5]

SdlsCfg::SaMap::SaMap ( const ElementType(&)  a[SIZE])

Constructor (primitive array)

Parameters
aThe array

Definition at line 25 of file SaMapArrayAc.cpp.

◆ SaMap() [3/5]

SdlsCfg::SaMap::SaMap ( const ElementType e)
explicit

Constructor (single element)

Parameters
eThe element

Definition at line 32 of file SaMapArrayAc.cpp.

◆ SaMap() [4/5]

SdlsCfg::SaMap::SaMap ( const std::initializer_list< ElementType > &  il)

Constructor (initializer list)

Parameters
ilThe initializer list

Definition at line 39 of file SaMapArrayAc.cpp.

◆ SaMap() [5/5]

SdlsCfg::SaMap::SaMap ( const SaMap obj)

Copy constructor.

Parameters
objThe source object

Definition at line 46 of file SaMapArrayAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus SdlsCfg::SaMap::deserializeFrom ( Fw::SerialBufferBase buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
)
virtual

Deserialization.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 162 of file SaMapArrayAc.cpp.

◆ operator!=()

bool SdlsCfg::SaMap::operator!= ( const SaMap obj) const

Inequality operator.

Parameters
objThe other object

Definition at line 125 of file SaMapArrayAc.cpp.

◆ operator=() [1/4]

SaMap & SdlsCfg::SaMap::operator= ( const SaMap obj)

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 71 of file SaMapArrayAc.cpp.

◆ operator=() [2/4]

SaMap & SdlsCfg::SaMap::operator= ( const ElementType(&)  a[SIZE])

Copy assignment operator (primitive array)

Parameters
aThe source array

Definition at line 82 of file SaMapArrayAc.cpp.

◆ operator=() [3/4]

SaMap & SdlsCfg::SaMap::operator= ( const std::initializer_list< ElementType > &  il)

Copy assignment operator (initializer list)

Parameters
ilThe initializer list

Definition at line 91 of file SaMapArrayAc.cpp.

◆ operator=() [4/4]

SaMap & SdlsCfg::SaMap::operator= ( const ElementType e)

Copy assignment operator (single element)

Parameters
eThe element

Definition at line 105 of file SaMapArrayAc.cpp.

◆ operator==()

bool SdlsCfg::SaMap::operator== ( const SaMap obj) const

Equality operator.

Parameters
objThe other object

Definition at line 114 of file SaMapArrayAc.cpp.

◆ operator[]() [1/2]

SaMap::ElementType & SdlsCfg::SaMap::operator[] ( const FwSizeType  i)

Subscript operator.

Parameters
iThe subscript index

Definition at line 57 of file SaMapArrayAc.cpp.

◆ operator[]() [2/2]

const SaMap::ElementType & SdlsCfg::SaMap::operator[] ( const FwSizeType  i) const

Const subscript operator.

Parameters
iThe subscript index

Definition at line 64 of file SaMapArrayAc.cpp.

◆ serializedSize()

FwSizeType SdlsCfg::SaMap::serializedSize ( ) const

Get the dynamic serialized size of the array.

Definition at line 178 of file SaMapArrayAc.cpp.

◆ serializeTo()

Fw::SerializeStatus SdlsCfg::SaMap::serializeTo ( Fw::SerialBufferBase buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
) const
virtual

Serialization.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 146 of file SaMapArrayAc.cpp.


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