#include <default/config/MemoryAllocatorTypeEnumAc.hpp>

Inheritance diagram for Fw::MemoryAllocation::MemoryAllocatorType:

Public Types
enum	T { CUSTOM_ALLOCATOR_1 = 0, SYSTEM = 1, OS_GENERIC_PRIORITY_QUEUE = 2 }
	The raw enum type. More...

enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 3 }

typedef U8	SerialType
	The serial representation type. More...

typedef enum T	t
	For backwards compatibility. More...

Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	MemoryAllocatorType ()
	Constructor (default value of CUSTOM_ALLOCATOR_1) More...

	MemoryAllocatorType (const enum T e1)
	Constructor (user-provided value) More...

	MemoryAllocatorType (const MemoryAllocatorType &obj)
	Copy constructor. More...

MemoryAllocatorType &	operator= (const MemoryAllocatorType &obj)
	Copy assignment operator (object) More...

MemoryAllocatorType &	operator= (enum T e1)
	Copy assignment operator (raw enum) More...

	operator enum T () const
	Conversion operator. More...

bool	operator== (enum T e1) const
	Equality operator. More...

bool	operator!= (enum T e1) const
	Inequality operator. More...

bool	isValid () const
	Check raw enum value for validity. More...

Fw::SerializeStatus	serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
	Serialize raw enum value to SerialType. More...

Fw::SerializeStatus	deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
	Deserialize raw enum value from SerialType. 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")

Public Attributes
enum T	e
	The raw enum value. More...

Additional Inherited Members
Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor. More...

virtual	~Serializable ()
	Virtual destructor. More...

Detailed Description

Enumeration of the registered memory allocators provided by Fw::MemAllocatorRegistry. This allows system designers to enumerate the memory functions in their system and configure the Fw::MemAllocatorRegistry to delegate to the appropriate allocator.

Definition at line 21 of file MemoryAllocatorTypeEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

typedef U8 Fw::MemoryAllocation::MemoryAllocatorType::SerialType

The serial representation type.

Definition at line 32 of file MemoryAllocatorTypeEnumAc.hpp.

◆ t

typedef enum T Fw::MemoryAllocation::MemoryAllocatorType::t

For backwards compatibility.

Definition at line 45 of file MemoryAllocatorTypeEnumAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.
NUM_CONSTANTS	The number of enumerated constants.

Definition at line 53 of file MemoryAllocatorTypeEnumAc.hpp.

◆ T

enum Fw::MemoryAllocation::MemoryAllocatorType::T

The raw enum type.

Enumerator
CUSTOM_ALLOCATOR_1	SAMPLE: sample allocator subsystem.
SYSTEM	REQUIRED: required for allocation for memory using a standard system allocator (i.e. the default)
OS_GENERIC_PRIORITY_QUEUE	REQUIRED: required for Os::Queue memory allocation when using queues that allocate memory.

Definition at line 35 of file MemoryAllocatorTypeEnumAc.hpp.

Constructor & Destructor Documentation

◆ MemoryAllocatorType() [1/3]

Fw::MemoryAllocation::MemoryAllocatorType::MemoryAllocatorType ( )

inline

Constructor (default value of CUSTOM_ALLOCATOR_1)

Definition at line 67 of file MemoryAllocatorTypeEnumAc.hpp.

◆ MemoryAllocatorType() [2/3]

Fw::MemoryAllocation::MemoryAllocatorType::MemoryAllocatorType ( const enum T e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 73 of file MemoryAllocatorTypeEnumAc.hpp.

◆ MemoryAllocatorType() [3/3]

Fw::MemoryAllocation::MemoryAllocatorType::MemoryAllocatorType ( const MemoryAllocatorType & obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 81 of file MemoryAllocatorTypeEnumAc.hpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Fw::MemoryAllocation::MemoryAllocatorType::deserializeFrom	(	Fw::SerialBufferBase &	buffer,
		Fw::Endianness	mode = `Fw::Endianness::BIG`
	)

virtual

Deserialize raw enum value from SerialType.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 70 of file MemoryAllocatorTypeEnumAc.cpp.

◆ isValid()

bool Fw::MemoryAllocation::MemoryAllocatorType::isValid ( ) const

Check raw enum value for validity.

Definition at line 51 of file MemoryAllocatorTypeEnumAc.cpp.

◆ operator enum T()

Fw::MemoryAllocation::MemoryAllocatorType::operator enum T ( ) const

inline

Conversion operator.

Definition at line 105 of file MemoryAllocatorTypeEnumAc.hpp.

◆ operator!=()

bool Fw::MemoryAllocation::MemoryAllocatorType::operator!= ( enum T e1 ) const

inline

Inequality operator.

Definition at line 117 of file MemoryAllocatorTypeEnumAc.hpp.

◆ operator=() [1/2]

MemoryAllocatorType & Fw::MemoryAllocation::MemoryAllocatorType::operator= ( const MemoryAllocatorType & obj )

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 22 of file MemoryAllocatorTypeEnumAc.cpp.

◆ operator=() [2/2]

MemoryAllocatorType & Fw::MemoryAllocation::MemoryAllocatorType::operator= ( enum T e1 )

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 29 of file MemoryAllocatorTypeEnumAc.cpp.

◆ operator==()

bool Fw::MemoryAllocation::MemoryAllocatorType::operator== ( enum T e1 ) const

inline

Equality operator.

Definition at line 111 of file MemoryAllocatorTypeEnumAc.hpp.

◆ serializeTo()

Fw::SerializeStatus Fw::MemoryAllocation::MemoryAllocatorType::serializeTo	(	Fw::SerialBufferBase &	buffer,
		Fw::Endianness	mode = `Fw::Endianness::BIG`
	)		const

virtual

Serialize raw enum value to SerialType.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 57 of file MemoryAllocatorTypeEnumAc.cpp.

Member Data Documentation

◆ e

enum T Fw::MemoryAllocation::MemoryAllocatorType::e

The raw enum value.

Definition at line 169 of file MemoryAllocatorTypeEnumAc.hpp.

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

default/config/MemoryAllocatorTypeEnumAc.hpp
default/config/MemoryAllocatorTypeEnumAc.cpp

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SerialType

◆ t

Member Enumeration Documentation

◆ anonymous enum

◆ T

Constructor & Destructor Documentation

◆ MemoryAllocatorType() [1/3]

◆ MemoryAllocatorType() [2/3]

◆ MemoryAllocatorType() [3/3]

Member Function Documentation

◆ deserializeFrom()

◆ isValid()

◆ operator enum T()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ serializeTo()

Member Data Documentation

◆ e