Fw Namespace Reference

Implementation of malloc based allocator. More...

Namespaces
	DpCfg
	MemoryAllocation
	StringUtils

Classes
class	Active
	Active and inactive states. More...
class	ActiveComponentBase
class	ActiveComponentExitSerializableBuffer
class	AmpcsEvrLogPacket
class	Array
class	ArrayMap
class	ArraySet
class	ArraySetOrMapImpl
class	AssertHook
class	Buffer
class	ByteArray
	A variable-length byte array. More...
class	CircularIndex
class	CmdArgBuffer
class	CmdPacket
class	CmdResponse
	Enum representing a command response. More...
class	CmdStringArg
class	ComBuffer
class	ComPacket
class	Completed
class	ConstByteArray
	A variable-length byte array with constant access. More...
class	ConstExternalString
	A string backed by an immutable string literal. More...
class	ConstStringBase
	A read-only abstract superclass for StringBase. More...
class	DeserialStatus
	Deserialization status. More...
class	Direction
	Direction states. More...
class	DpContainer
	A data product Container. More...
class	DpState
class	Enabled
	Enabled and disabled states. More...
class	ExternalArray
class	ExternalArrayMap
class	ExternalArraySet
class	ExternalFifoQueue
class	ExternalRedBlackTreeMap
class	ExternalRedBlackTreeSet
class	ExternalSerializeBuffer
	External serialize buffer with no copy semantics. More...
class	ExternalSerializeBufferWithDataCopy
	External serialize buffer with data copy semantics. More...
class	ExternalSerializeBufferWithMemberCopy
	External serialize buffer with member copy semantics. More...
class	ExternalStack
class	ExternalString
	A string backed by an external buffer. More...
class	FifoQueue
class	FifoQueueBase
class	FileNameString
class	FilePacket
	A file packet. More...
class	Health
	Health states. More...
class	InputBufferGetPort
class	InputBufferSendPort
class	InputCmdPort
class	InputCmdRegPort
class	InputCmdResponsePort
class	InputCompletionStatusPort
class	InputComPort
class	InputDpGetPort
class	InputDpRequestPort
class	InputDpResponsePort
class	InputDpSendPort
class	InputLogPort
class	InputLogTextPort
class	InputPortBase
class	InputPrmGetPort
class	InputPrmSetPort
class	InputReadyPort
class	InputSignalPort
class	InputSuccessConditionPort
class	InputTimeIntervalPort
class	InputTimePort
class	InputTlmGetPort
class	InputTlmPort
class	InternalInterfaceString
class	LinearBufferBase
class	LogBuffer
class	Logger
class	Logic
	Logic states. More...
class	LogPacket
class	LogSeverity
	Enum representing event severity. More...
class	LogStringArg
class	MallocAllocator
	malloc based memory allocator More...
class	MapBase
class	MapConstIterator
class	MapEntryBase
class	MemAllocator
	Memory Allocation base class. More...
class	MemAllocatorRegistry
class	MmapAllocator
struct	Nil
class	ObjBase
	Brief class description. More...
class	ObjectName
class	On
	On and off states. More...
class	Open
	Open and closed states. More...
class	OutputBufferGetPort
class	OutputBufferSendPort
class	OutputCmdPort
class	OutputCmdRegPort
class	OutputCmdResponsePort
class	OutputCompletionStatusPort
class	OutputComPort
class	OutputDpGetPort
class	OutputDpRequestPort
class	OutputDpResponsePort
class	OutputDpSendPort
class	OutputLogPort
class	OutputLogTextPort
class	OutputPortBase
class	OutputPrmGetPort
class	OutputPrmSetPort
class	OutputReadyPort
class	OutputSignalPort
class	OutputSuccessConditionPort
class	OutputTimeIntervalPort
class	OutputTimePort
class	OutputTlmGetPort
class	OutputTlmPort
class	ParamBuffer
class	ParamExternalDelegate
class	ParamString
class	ParamValid
	Enum representing parameter validity. More...
class	PassiveComponentBase
class	PolyType
class	PortBase
class	QueuedComponentBase
class	RedBlackTreeMap
class	RedBlackTreeSet
class	RedBlackTreeSetOrMapImpl
class	SerialBuffer
	A variable-length serializable buffer. More...
class	SerialBufferBase
class	Serializable
class	SerializableFile
	The type of a packet header. More...
struct	Serialization
class	SerialStatus
	Serialization status. More...
class	SetBase
class	SetConstIterator
class	SetOrMapImplConstIterator
class	SetOrMapImplEntry
class	SizedContainer
class	SmSignalBuffer
class	Stack
class	StackBase
class	StatementArgBuffer
class	String
class	StringBase
class	StringTemplate
class	Success
	Success/Failure. More...
class	TextLogString
class	Time
class	TimeComparison
class	TimeInterval
class	TimeIntervalValue
	Data structure for Time Interval. More...
class	TimeValue
	Data structure for Time. More...
class	TlmBuffer
class	TlmPacket
class	TlmString
class	TlmValid
class	TrapHandler
class	Wait
	Wait or don't wait for something. More...

Typedefs
using	ComPacketType = ComCfg::Apid::T
using	SerializeBufferBase = LinearBufferBase
	forward declaration More...

Enumerations
enum	FormatStatus {   FormatStatus::SUCCESS, FormatStatus::OVERFLOWED, FormatStatus::INVALID_FORMAT_STRING, FormatStatus::SIZE_OVERFLOW,   FormatStatus::OTHER_ERROR }
	status of string format calls More...
enum	SerializeStatus {   FW_SERIALIZE_OK, FW_SERIALIZE_FORMAT_ERROR, FW_SERIALIZE_NO_ROOM_LEFT, FW_DESERIALIZE_BUFFER_EMPTY,   FW_DESERIALIZE_FORMAT_ERROR, FW_DESERIALIZE_SIZE_MISMATCH, FW_DESERIALIZE_TYPE_MISMATCH, FW_DESERIALIZE_IMMUTABLE,   FW_SERIALIZE_DISCARDED_EXISTING }
	forward declaration for string More...
enum	Endianness { Endianness::BIG, Endianness::LITTLE }
enum	{   FW_TYPEID_U8 = 10, FW_TYPEID_18 = 11, FW_TYPEID_U16 = 12, FW_TYPEID_I16 = 13,   FW_TYPEID_U32 = 14, FW_TYPEID_I32 = 15, FW_TYPEID_U64 = 16, FW_TYPEID_I64 = 17,   FW_TYPEID_F32 = 18, FW_TYPEID_F64 = 19, FW_TYPEID_BOOL = 20, FW_TYPEID_PTR = 21,   FW_TYPEID_BUFF = 22, FW_TYPEID_POLY = 30, FW_TYPEID_CMD_BUFF = 40, FW_TYPEID_CMD_STR = 41,   FW_TYPEID_TLM_BUFF = 42, FW_TYPEID_TLM_STR = 43, FW_TYPEID_LOG_BUFF = 44, FW_TYPEID_LOG_STR = 45,   FW_TYPEID_PRM_BUFF = 46, FW_TYPEID_PRM_STR = 47, FW_TYPEID_FILE_BUFF = 48, FW_TYPEID_EIGHTY_CHAR_STRING = 50,   FW_TYPEID_INTERNAL_INTERFACE_STRING = 51, FW_TYPEID_FIXED_LENGTH_STRING = 52, FW_TYPEID_OBJECT_NAME = 53, FW_TYPEID_FILE_NAME_STRING = 54 }

Functions
template<typename T >
T *	arrayPlacementNew (Fw::ByteArray array, FwSizeType arraySize)
	placement new for arrays More...
template<typename T >
void	arrayPlacementDestruct (T *arrayPointer, FwSizeType arraySize)
	placement delete for arrays More...
void	defaultPrintAssert (const CHAR *msg)
void	defaultReportAssert (FILE_NAME_ARG file, FwSizeType lineNo, FwSizeType numArgs, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6, CHAR *destBuffer, FwSizeType buffSize)
I8	defaultSwAssert (FILE_NAME_ARG file, FwSizeType lineNo, FwSizeType numArgs, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6)
I8	SwAssert (FILE_NAME_ARG file, FwSizeType lineNo) NOINLINE CLANG_ANALYZER_NORETURN
	Assert with no arguments. More...
I8	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwSizeType lineNo) NOINLINE CLANG_ANALYZER_NORETURN
	Assert with one argument. More...
I8	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwSizeType lineNo) NOINLINE CLANG_ANALYZER_NORETURN
	Assert with two arguments. More...
I8	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwSizeType lineNo) NOINLINE CLANG_ANALYZER_NORETURN
	Assert with three arguments. More...
I8	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwSizeType lineNo) NOINLINE CLANG_ANALYZER_NORETURN
	Assert with four arguments. More...
I8	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwSizeType lineNo) NOINLINE CLANG_ANALYZER_NORETURN
	Assert with five arguments. More...
I8	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6, FwSizeType lineNo) NOINLINE CLANG_ANALYZER_NORETURN
	Assert with six arguments. More...
FormatStatus	stringFormat (char *destination, const FwSizeType maximumSize, const char *formatString,...)
	format a c-string More...
FormatStatus	stringFormat (char *destination, const FwSizeType maximumSize, const char *formatString, va_list args)
	format a c-string More...

Variables
const Time	ZERO_TIME = Time()

Detailed Description

Implementation of malloc based allocator.

File: Logger.cpp Description: Framework logging implementation Author: mstarch

This file adds in support to the core 'Fw' package, to separate it from Os and other loggers, and allow the architect of the system to select which core framework logging should be used.

Author

T. Canham

Copyright

Copyright 2009-2016, by the California Institute of Technology. ALL RIGHTS RESERVED. United States Government Sponsorship acknowledged.

Copyright 2009-2016, by the California Institute of Technology. ALL RIGHTS RESERVED. United States Government Sponsorship acknowledged.

Fw/Types/StringUtils.hpp:

C-string helper utilities. Note: wherever possible, use Fw::StringBase and derived classes instead of raw C-strings.

Typedef Documentation

ComPacketType

using Fw::ComPacketType = typedef ComCfg::Apid::T

Definition at line 20 of file ComPacket.hpp.

SerializeBufferBase

using Fw::SerializeBufferBase = typedef LinearBufferBase

forward declaration

Definition at line 30 of file Serializable.hpp.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
FW_TYPEID_U8	U8 serialized type id.
FW_TYPEID_18	I8 serialized type id.
FW_TYPEID_U16	U16 serialized type id.
FW_TYPEID_I16	I16 serialized type id.
FW_TYPEID_U32	U32 serialized type id.
FW_TYPEID_I32	I32 serialized type id.
FW_TYPEID_U64	U64 serialized type id.
FW_TYPEID_I64	I64 serialized type id.
FW_TYPEID_F32	F32 serialized type id.
FW_TYPEID_F64	F64 serialized type id.
FW_TYPEID_BOOL	boolean serialized type id
FW_TYPEID_PTR	pointer serialized type id
FW_TYPEID_BUFF	buffer serialized type id
FW_TYPEID_POLY	PolyType serialized type id.
FW_TYPEID_CMD_BUFF	Command Buffer type id.
FW_TYPEID_CMD_STR	Command string type id.
FW_TYPEID_TLM_BUFF	Telemetry Buffer type id.
FW_TYPEID_TLM_STR	Telemetry string type id.
FW_TYPEID_LOG_BUFF	Log Buffer type id.
FW_TYPEID_LOG_STR	Log string type id.
FW_TYPEID_PRM_BUFF	Parameter Buffer type id.
FW_TYPEID_PRM_STR	Parameter string type id.
FW_TYPEID_FILE_BUFF	File piece Buffer type id.
FW_TYPEID_EIGHTY_CHAR_STRING	80 char string Buffer type id
FW_TYPEID_INTERNAL_INTERFACE_STRING	interface string Buffer type id
FW_TYPEID_FIXED_LENGTH_STRING	256 char string Buffer type id
FW_TYPEID_OBJECT_NAME	ObjectName string Buffer type id.
FW_TYPEID_FILE_NAME_STRING	FileName string Buffer type id.

Definition at line 21 of file SerIds.hpp.

Endianness

enum Fw::Endianness

strong

Enumerator
BIG	Big endian serialization.
LITTLE	Little endian serialization.

Definition at line 39 of file Serializable.hpp.

FormatStatus

enum Fw::FormatStatus

strong

status of string format calls

Enumerator
SUCCESS	Format worked.
OVERFLOWED	Format overflowed.
INVALID_FORMAT_STRING	Format provided invalid format string.
SIZE_OVERFLOW	FwSizeType overflowed the range of size_t.
OTHER_ERROR	An error was returned from an underlying call.

Definition at line 18 of file format.hpp.

SerializeStatus

enum Fw::SerializeStatus

forward declaration for string

Enumerator
FW_SERIALIZE_OK	Serialization/Deserialization operation was successful.
FW_SERIALIZE_FORMAT_ERROR	Data was the wrong format (e.g. wrong packet type)
FW_SERIALIZE_NO_ROOM_LEFT	No room left in the buffer to serialize data.
FW_DESERIALIZE_BUFFER_EMPTY	Deserialization buffer was empty when trying to read more data.
FW_DESERIALIZE_FORMAT_ERROR	Deserialization data had incorrect values (unexpected data types)
FW_DESERIALIZE_SIZE_MISMATCH	Data was left in the buffer, but not enough to deserialize.
FW_DESERIALIZE_TYPE_MISMATCH	Deserialized type ID didn't match.
FW_DESERIALIZE_IMMUTABLE	Attempted to deserialize into an immutable buffer.
FW_SERIALIZE_DISCARDED_EXISTING	Serialization succeeded, but deleted old data.

Definition at line 14 of file Serializable.hpp.

Function Documentation

arrayPlacementDestruct()

template<typename T >

void Fw::arrayPlacementDestruct	(	T *	arrayPointer,
		FwSizeType	arraySize
	)

placement delete for arrays

This is the partner of tha above function that performs the destructor operation on every element of type T in the array. This assumes that all elements have been constructed.

Warning

this function cannot be used for arrays of arrays (i.e. T cannot be an array type).

Template Parameters

T	the type of the array elements

Parameters

arrayPointer	pointer to an array of type T
arraySize	the number of elements in the array

Definition at line 62 of file LanguageHelpers.hpp.

arrayPlacementNew()

template<typename T >

T* Fw::arrayPlacementNew	(	Fw::ByteArray	array,
		FwSizeType	arraySize
	)

placement new for arrays

C++ as a language does not guaranteed that placement new for a C++ array of length N will fit within a memory region of size N *sizeof(T). Moreover, there are some compilers whose implementation of placement new for arrays do not guarantee this property.

This function provides a helper for placement new for arrays that guarantees that the array will fit within the provided memory region. It checks that the provided memory region is large enough to hold the array (N * sizeof(T) and that the alignment of the provided memory region is sufficient for the type T. It also checks that the provided memory region is non-null.

Warning

this function cannot be used for arrays of arrays (i.e. T cannot be an array type).

Template Parameters

T	the type of the array elements

Parameters

array	the byte array to use for placement new (pair of bytes pointer and size)
arraySize	the number of elements in the array

Returns

a pointer to the array of type T

Definition at line 36 of file LanguageHelpers.hpp.

defaultPrintAssert()

void Fw::defaultPrintAssert

(

const CHAR *

msg

)

Definition at line 16 of file Assert.cpp.

defaultReportAssert()

void Fw::defaultReportAssert	(	FILE_NAME_ARG	file,
		FwSizeType	lineNo,
		FwSizeType	numArgs,
		FwAssertArgType	arg1,
		FwAssertArgType	arg2,
		FwAssertArgType	arg3,
		FwAssertArgType	arg4,
		FwAssertArgType	arg5,
		FwAssertArgType	arg6,
		CHAR *	destBuffer,
		FwSizeType	buffSize
	)

Definition at line 22 of file Assert.cpp.

defaultSwAssert()

I8 Fw::defaultSwAssert	(	FILE_NAME_ARG	file,
		FwSizeType	lineNo,
		FwSizeType	numArgs,
		FwAssertArgType	arg1,
		FwAssertArgType	arg2,
		FwAssertArgType	arg3,
		FwAssertArgType	arg4,
		FwAssertArgType	arg5,
		FwAssertArgType	arg6
	)

Definition at line 112 of file Assert.cpp.

stringFormat() [1/2]

Fw::FormatStatus Fw::stringFormat	(	char *	destination,
		const FwSizeType	maximumSize,
		const char *	formatString,
			...
	)

format a c-string

Format a string using printf family formatting semantics. Destination will be filled with the formatted string up to maximumSize - 1. This function will always terminate the string with a \0.

This function can return several error codes: OVERFLOWED: the complete string did not fit in the buffer with an appended null-terminator INVALID_FORMAT_STRING: the format string was null OTHER_ERROR: another error occurred in an underlying function call Otherwise SUCCESS is returned. destination may be modified even in the case of an error.

Parameters

destination	destination to fill with the formatted string
maximumSize	size of the buffer represented by destination
formatString	format string to fill
...	variable arguments inputs

Returns

: SUCCESS on successful formatting, OVERFLOWED on overflow, and something else on any error

Definition at line 10 of file snprintf_format.cpp.

stringFormat() [2/2]

Fw::FormatStatus Fw::stringFormat	(	char *	destination,
		const FwSizeType	maximumSize,
		const char *	formatString,
		va_list	args
	)

format a c-string

Format a string using printf family formatting semantics. Destination will be filled with the formatted string up to maximumSize - 1. This function will always terminate the string with a \0.

This function can return several error codes: OVERFLOWED: the complete string did not fit in the buffer with an appended null-terminator INVALID_FORMAT_STRING: the format string was null OTHER_ERROR: another error occurred in an underlying function call Otherwise SUCCESS is returned. destination may be modified even in the case of an error.

This version take a variable argument list

Parameters

destination	destination to fill with the formatted string
maximumSize	size of the buffer represented by destination
formatString	format string to fill
args	variable arguments list

Returns

: SUCCESS on successful formatting, OVERFLOWED on overflow, and something else on any error

Definition at line 18 of file snprintf_format.cpp.

SwAssert() [1/7]

I8 Fw::SwAssert	(	FILE_NAME_ARG	file,
		FwSizeType	lineNo
	)

Assert with no arguments.

Definition at line 135 of file Assert.cpp.

SwAssert() [2/7]

I8 Fw::SwAssert	(	FILE_NAME_ARG	file,
		FwAssertArgType	arg1,
		FwSizeType	lineNo
	)

Assert with one argument.

Definition at line 139 of file Assert.cpp.

SwAssert() [3/7]

I8 Fw::SwAssert	(	FILE_NAME_ARG	file,
		FwAssertArgType	arg1,
		FwAssertArgType	arg2,
		FwSizeType	lineNo
	)

Assert with two arguments.

Definition at line 143 of file Assert.cpp.

SwAssert() [4/7]

I8 Fw::SwAssert	(	FILE_NAME_ARG	file,
		FwAssertArgType	arg1,
		FwAssertArgType	arg2,
		FwAssertArgType	arg3,
		FwSizeType	lineNo
	)

Assert with three arguments.

Definition at line 147 of file Assert.cpp.

SwAssert() [5/7]

I8 Fw::SwAssert	(	FILE_NAME_ARG	file,
		FwAssertArgType	arg1,
		FwAssertArgType	arg2,
		FwAssertArgType	arg3,
		FwAssertArgType	arg4,
		FwSizeType	lineNo
	)

Assert with four arguments.

Definition at line 151 of file Assert.cpp.

SwAssert() [6/7]

I8 Fw::SwAssert	(	FILE_NAME_ARG	file,
		FwAssertArgType	arg1,
		FwAssertArgType	arg2,
		FwAssertArgType	arg3,
		FwAssertArgType	arg4,
		FwAssertArgType	arg5,
		FwSizeType	lineNo
	)

Assert with five arguments.

Definition at line 160 of file Assert.cpp.

SwAssert() [7/7]

I8 Fw::SwAssert	(	FILE_NAME_ARG	file,
		FwAssertArgType	arg1,
		FwAssertArgType	arg2,
		FwAssertArgType	arg3,
		FwAssertArgType	arg4,
		FwAssertArgType	arg5,
		FwAssertArgType	arg6,
		FwSizeType	lineNo
	)

Assert with six arguments.

Definition at line 170 of file Assert.cpp.

Variable Documentation

ZERO_TIME

const Time Fw::ZERO_TIME = Time()

Definition at line 5 of file Time.cpp.