Implementation of malloc based allocator. More...

Namespaces
	BasicTypes

	DpCfg

	MemoryAllocation

	StringUtils

Classes
class	Active
	Active and inactive states. More...

class	ActiveComponentBase

class	ActiveComponentExitSerializableBuffer

class	Array

class	ArrayMap

class	ArraySet

class	ArraySetOrMapImpl

class	AssertHook

class	Buffer

class	BufferSendPortBuffer

class	BufferSendPortSerializer

class	ByteArray
	A variable-length byte array. More...

class	CircularIndex

class	CmdPacket

class	CmdPortBuffer

class	CmdPortSerializer

class	CmdRegPortBuffer

class	CmdRegPortSerializer

class	CmdResponse
	Enum representing a command response. More...

class	CmdResponsePortBuffer

class	CmdResponsePortSerializer

class	ComPacket

class	Completed

class	CompletionStatusPortBuffer

class	CompletionStatusPortSerializer

class	ComPortBuffer

class	ComPortSerializer

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	DpRequestPortBuffer

class	DpRequestPortSerializer

class	DpResponsePortBuffer

class	DpResponsePortSerializer

class	DpSendPortBuffer

class	DpSendPortSerializer

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	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	LinearBufferBase

class	LinearBufferTemplate

class	Logger

class	Logic
	Logic states. More...

class	LogPacket

class	LogPortBuffer

class	LogPortSerializer

class	LogSeverity
	Enum representing event severity. More...

class	LogTextPortBuffer

class	LogTextPortSerializer

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

struct	None_t
	Sentinel type representing the absence of a value in an Optional. More...

class	ObjBase
	Brief class description. More...

class	On
	On and off states. More...

class	Open
	Open and closed states. More...

class	Optional
	A type-safe container for an optional value. 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	ParamExternalDelegate

class	ParamValid
	Enum representing parameter validity. More...

class	PassiveComponentBase

class	PolyType

class	PortBase

class	PrmSetPortBuffer

class	PrmSetPortSerializer

class	QueuedComponentBase

class	ReadyPortBuffer

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
	forward declaration More...

class	SerialStatus
	Serialization status. More...

class	SetBase

class	SetConstIterator

class	SetOrMapImplConstIterator

class	SetOrMapImplEntry

class	SignalPortBuffer

class	SizedContainer

class	Stack

class	StackBase

class	StatementArgBuffer

class	StringBase

class	StringFormatStatus
	FPP shadow-enum representing Fw::FormatStatus. More...

class	StringTemplate

class	Success
	Success/Failure. More...

class	SuccessConditionPortBuffer

class	SuccessConditionPortSerializer

class	Time

class	TimeComparison

class	TimeInterval

class	TimeIntervalPortBuffer

class	TimeIntervalPortSerializer

class	TimeIntervalValue
	Data structure for Time Interval. More...

class	TimePortBuffer

class	TimePortSerializer

class	TimeValue
	Data structure for Time. More...

class	TlmPacket

class	TlmPortBuffer

class	TlmPortSerializer

class	TlmValid

class	TrapHandler

class	Wait
	Wait or don't wait for something. More...

Typedefs
using	CmdArgBuffer = LinearBufferTemplate< FW_CMD_ARG_BUFFER_MAX_SIZE >

using	CmdStringArg = StringTemplate< FW_CMD_STRING_MAX_SIZE >

using	ComBuffer = LinearBufferTemplate< FW_COM_BUFFER_MAX_SIZE >

using	ComPacketType = ComCfg::Apid::T

using	LogBuffer = LinearBufferTemplate< FW_LOG_BUFFER_MAX_SIZE >

using	LogStringArg = StringTemplate< FW_LOG_STRING_MAX_SIZE >

using	TextLogString = StringTemplate< FW_LOG_TEXT_BUFFER_SIZE >

using	ParamBuffer = LinearBufferTemplate< FW_PARAM_BUFFER_MAX_SIZE >

using	ParamString = StringTemplate< FW_PARAM_STRING_MAX_SIZE >

using	SmSignalBuffer = LinearBufferTemplate< FW_SM_SIGNAL_BUFFER_MAX_SIZE >

using	TlmBuffer = LinearBufferTemplate< FW_TLM_BUFFER_MAX_SIZE >

using	TlmString = StringTemplate< FW_TLM_STRING_MAX_SIZE >

using	FileNameString = StringTemplate< FileNameStringSize >

using	InternalInterfaceString = StringTemplate< FW_INTERNAL_INTERFACE_STRING_MAX_SIZE >

using	ObjectName = StringTemplate< FW_OBJ_NAME_BUFFER_SIZE >

using	String = StringTemplate< FW_FIXED_LENGTH_STRING_SIZE >

Enumerations
enum	FormatStatus { FormatStatus::SUCCESS, FormatStatus::OVERFLOWED, FormatStatus::INVALID_FORMAT_STRING, FormatStatus::SIZE_OVERFLOW, FormatStatus::OTHER_ERROR }
	status of string format calls More...

enum	ScanStatus { ScanStatus::SUCCESS, ScanStatus::INVALID_FORMAT_STRING, ScanStatus::SIZE_OVERFLOW, ScanStatus::UNTERMINATED_SOURCE_STRING, ScanStatus::OTHER_ERROR }
	status of string scan 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_DESERIALIZE_INVALID_DATA, FW_SERIALIZE_DISCARDED_EXISTING }
	forward declaration for string More...

enum	Endianness { Endianness::BIG, Endianness::LITTLE }

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...

FW_ASSERT_NORETURN void	defaultSwAssert (FILE_NAME_ARG file, FwSizeType lineNo, FwSizeType numArgs, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6)

void	SwAssert (FILE_NAME_ARG file, FwSizeType lineNo) NOINLINE FW_ASSERT_NORETURN
	Assert with no arguments. More...

void	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwSizeType lineNo) NOINLINE FW_ASSERT_NORETURN
	Assert with one argument. More...

void	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwSizeType lineNo) NOINLINE FW_ASSERT_NORETURN
	Assert with two arguments. More...

void	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwSizeType lineNo) NOINLINE FW_ASSERT_NORETURN
	Assert with three arguments. More...

void	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwSizeType lineNo) NOINLINE FW_ASSERT_NORETURN
	Assert with four arguments. More...

void	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwSizeType lineNo) NOINLINE FW_ASSERT_NORETURN
	Assert with five arguments. More...

void	SwAssert (FILE_NAME_ARG file, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6, FwSizeType lineNo) NOINLINE FW_ASSERT_NORETURN
	Assert with six arguments. More...

void	formatAssertMessage (FILE_NAME_ARG file, FwSizeType lineNo, FwSizeType numArgs, FwAssertArgType arg1, FwAssertArgType arg2, FwAssertArgType arg3, FwAssertArgType arg4, FwAssertArgType arg5, FwAssertArgType arg6, CHAR *destBuffer, FwSizeType buffSize)
	format an assert message More...

void	printAssertMessage (const CHAR *msg)
	print an assert message More...

void	terminateOnAssert ()
	terminate after a failed assertion 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...

ScanStatus	stringScan (FwSizeType &count, const char source, FwSizeType maximumSize, const char formatString,...)
	scan a c-string More...

ScanStatus	stringScan (FwSizeType &count, const char source, FwSizeType maximumSize, const char formatString, va_list args)
	scan a c-string using a variable argument list More...

Variables
const Time	ZERO_TIME = Time()

constexpr None_t	NONE = None_t()
	Global constant representing an absent/empty optional value. More...

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. Each function below documents the standard C string call it is a bounded, safe replacement for.

Typedef Documentation

◆ CmdArgBuffer

using Fw::CmdArgBuffer = typedef LinearBufferTemplate<FW_CMD_ARG_BUFFER_MAX_SIZE>

Definition at line 14 of file CmdArgBuffer.hpp.

◆ CmdStringArg

using Fw::CmdStringArg = typedef StringTemplate<FW_CMD_STRING_MAX_SIZE>

Definition at line 14 of file CmdString.hpp.

◆ ComBuffer

using Fw::ComBuffer = typedef LinearBufferTemplate<FW_COM_BUFFER_MAX_SIZE>

Definition at line 14 of file ComBuffer.hpp.

◆ ComPacketType

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

Definition at line 20 of file ComPacket.hpp.

◆ FileNameString

using Fw::FileNameString = typedef StringTemplate<FileNameStringSize>

Definition at line 15 of file FileNameString.hpp.

◆ InternalInterfaceString

using Fw::InternalInterfaceString = typedef StringTemplate<FW_INTERNAL_INTERFACE_STRING_MAX_SIZE>

Definition at line 15 of file InternalInterfaceString.hpp.

◆ LogBuffer

using Fw::LogBuffer = typedef LinearBufferTemplate<FW_LOG_BUFFER_MAX_SIZE>

Definition at line 14 of file LogBuffer.hpp.

◆ LogStringArg

using Fw::LogStringArg = typedef StringTemplate<FW_LOG_STRING_MAX_SIZE>

Definition at line 14 of file LogString.hpp.

◆ ObjectName

using Fw::ObjectName = typedef StringTemplate<FW_OBJ_NAME_BUFFER_SIZE>

Definition at line 14 of file ObjectName.hpp.

◆ ParamBuffer

using Fw::ParamBuffer = typedef LinearBufferTemplate<FW_PARAM_BUFFER_MAX_SIZE>

Definition at line 18 of file PrmBuffer.hpp.

◆ ParamString

using Fw::ParamString = typedef StringTemplate<FW_PARAM_STRING_MAX_SIZE>

Definition at line 14 of file PrmString.hpp.

◆ SmSignalBuffer

using Fw::SmSignalBuffer = typedef LinearBufferTemplate<FW_SM_SIGNAL_BUFFER_MAX_SIZE>

Definition at line 14 of file SmSignalBuffer.hpp.

◆ String

using Fw::String = typedef StringTemplate<FW_FIXED_LENGTH_STRING_SIZE>

Definition at line 14 of file String.hpp.

◆ TextLogString

using Fw::TextLogString = typedef StringTemplate<FW_LOG_TEXT_BUFFER_SIZE>

Definition at line 14 of file TextLogString.hpp.

◆ TlmBuffer

using Fw::TlmBuffer = typedef LinearBufferTemplate<FW_TLM_BUFFER_MAX_SIZE>

Definition at line 14 of file TlmBuffer.hpp.

◆ TlmString

using Fw::TlmString = typedef StringTemplate<FW_TLM_STRING_MAX_SIZE>

Definition at line 14 of file TlmString.hpp.

Enumeration Type Documentation

◆ Endianness

enum Fw::Endianness

strong

Enumerator
BIG	Big endian serialization.
LITTLE	Little endian serialization.

Definition at line 37 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.

◆ ScanStatus

enum Fw::ScanStatus

strong

status of string scan calls

Enumerator
SUCCESS	Scan worked.
INVALID_FORMAT_STRING	Format provided invalid format string.
SIZE_OVERFLOW	FwSizeType overflowed the range of size_t.
UNTERMINATED_SOURCE_STRING	The source string was not null-terminated within the maximum size.
OTHER_ERROR	An error was returned from an underlying call.

Definition at line 18 of file scan.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_DESERIALIZE_INVALID_DATA	Data failed validation.
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.

◆ defaultSwAssert()

FW_ASSERT_NORETURN void 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 50 of file Assert.cpp.

◆ formatAssertMessage()

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

format an assert message

Formats the location of a failed assertion and its arguments into destBuffer. Called by the framework when no Fw::AssertHook is registered, by the default Fw::AssertHook::reportAssert, and by Svc::AssertFatalAdapter. Implementations must leave destBuffer null-terminated whenever buffSize is greater than zero; an empty string is acceptable.

Parameters

file	file name or file ID (depending on FW_ASSERT_LEVEL)
lineNo	line number where the assert occurred
numArgs	number of additional arguments (0-6)
arg1	assert argument 1 (used when numArgs >= 1)
arg2	assert argument 2 (used when numArgs >= 2)
arg3	assert argument 3 (used when numArgs >= 3)
arg4	assert argument 4 (used when numArgs >= 4)
arg5	assert argument 5 (used when numArgs >= 5)
arg6	assert argument 6 (used when numArgs >= 6)
destBuffer	buffer to write the formatted message to
buffSize	size of destBuffer

Definition at line 27 of file fputs_assert_hook.cpp.

◆ printAssertMessage()

void Fw::printAssertMessage ( const CHAR * msg )

print an assert message

Outputs a message formatted by formatAssertMessage. Called by the framework when no Fw::AssertHook is registered and by the default Fw::AssertHook::printAssert.

Parameters

msg	null-terminated string containing the formatted assert message

Definition at line 21 of file fputs_assert_hook.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 takes 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.

◆ stringScan() [1/2]

Fw::ScanStatus Fw::stringScan	(	FwSizeType &	count,
		const char *	source,
		FwSizeType	maximumSize,
		const char *	formatString,
			...
	)

scan a c-string

Scan a string using sscanf family formatting semantics. Source will be read according to the format string. The number of filled fields will be returned in count. Read characters will not exceed maximumSize.

This function can return several error codes: INVALID_FORMAT_STRING: the format string was null SIZE_OVERFLOW: FwSizeType overflowed the range of size_t OTHER_ERROR: another error occurred in an underlying function call Otherwise SUCCESS is returned.

Parameters

count	[output] number of filled fields
source	source string to scan
maximumSize	size of the buffer represented by source
formatString	format string to fill
...	variable arguments inputs

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

Definition at line 11 of file sscanf_scan.cpp.

◆ stringScan() [2/2]

Fw::ScanStatus Fw::stringScan	(	FwSizeType &	count,
		const char *	source,
		FwSizeType	maximumSize,
		const char *	formatString,
		va_list	args
	)

scan a c-string using a variable argument list

Scan a string using sscanf family formatting semantics. Source will be read according to the format string. The number of filled fields will be returned in count. Read characters will not exceed maximumSize.

This function can return several error codes: INVALID_FORMAT_STRING: the format string was null SIZE_OVERFLOW: FwSizeType overflowed the range of size_t OTHER_ERROR: another error occurred in an underlying function call Otherwise SUCCESS is returned.

This version takes a variable argument list

Parameters

count	[output] number of filled fields
source	source string to scan
maximumSize	size of the buffer represented by source
formatString	format string to fill
args	variable arguments list

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

Definition at line 23 of file sscanf_scan.cpp.

◆ SwAssert() [1/7]

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

Assert with no arguments.

Definition at line 75 of file Assert.cpp.

◆ SwAssert() [2/7]

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

Assert with one argument.

Definition at line 79 of file Assert.cpp.

◆ SwAssert() [3/7]

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

Assert with two arguments.

Definition at line 83 of file Assert.cpp.

◆ SwAssert() [4/7]

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

Assert with three arguments.

Definition at line 87 of file Assert.cpp.

◆ SwAssert() [5/7]

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

Assert with four arguments.

Definition at line 91 of file Assert.cpp.

◆ SwAssert() [6/7]

void 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 100 of file Assert.cpp.

◆ SwAssert() [7/7]

void 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 110 of file Assert.cpp.

◆ terminateOnAssert()

void Fw::terminateOnAssert ( )

terminate after a failed assertion

Called by the framework after printAssertMessage when no Fw::AssertHook is registered, and by the default Fw::AssertHook::doAssert. Implementations typically call assert(false), which is compiled out when NDEBUG is defined; FW_ASSERTIONS_ALWAYS_ABORT then decides whether execution may continue.

Definition at line 17 of file fputs_assert_hook.cpp.

Variable Documentation

◆ NONE

constexpr None_t Fw::NONE = None_t()

Global constant representing an absent/empty optional value.

Definition at line 31 of file Optional.hpp.

◆ ZERO_TIME

const Time Fw::ZERO_TIME = Time()

Definition at line 5 of file Time.cpp.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ CmdArgBuffer

◆ CmdStringArg

◆ ComBuffer

◆ ComPacketType

◆ FileNameString

◆ InternalInterfaceString

◆ LogBuffer

◆ LogStringArg

◆ ObjectName

◆ ParamBuffer

◆ ParamString

◆ SmSignalBuffer

◆ String

◆ TextLogString

◆ TlmBuffer

◆ TlmString

Enumeration Type Documentation

◆ Endianness

◆ FormatStatus

◆ ScanStatus

◆ SerializeStatus

Function Documentation

◆ arrayPlacementDestruct()

◆ arrayPlacementNew()

◆ defaultSwAssert()

◆ formatAssertMessage()

◆ printAssertMessage()

◆ stringFormat() [1/2]

◆ stringFormat() [2/2]

◆ stringScan() [1/2]

◆ stringScan() [2/2]

◆ SwAssert() [1/7]

◆ SwAssert() [2/7]

◆ SwAssert() [3/7]

◆ SwAssert() [4/7]

◆ SwAssert() [5/7]

◆ SwAssert() [6/7]

◆ SwAssert() [7/7]

◆ terminateOnAssert()

Variable Documentation

◆ NONE

◆ ZERO_TIME