Auto-generated base for AssertFatalAdapter component. More...

#include <docs-cache/F-Prime/Svc/AssertFatalAdapter/AssertFatalAdapterComponentAc.hpp>

Inheritance diagram for Svc::AssertFatalAdapterComponentBase:

Public Member Functions
void	init (NATIVE_INT_TYPE instance=0)
	Initialize AssertFatalAdapterComponentBase object.

void	set_Log_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
	Connect port to Log[portNum].

void	set_Time_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
	Connect port to Time[portNum].

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base.

U32	getIdBase () const

Protected Types
enum	{ NUM_LOG_OUTPUT_PORTS = 1 , NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_TIME_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ EVENTID_AF_ASSERT_0 = 0x0 , EVENTID_AF_ASSERT_1 = 0x1 , EVENTID_AF_ASSERT_2 = 0x2 , EVENTID_AF_ASSERT_3 = 0x3 , EVENTID_AF_ASSERT_4 = 0x4 , EVENTID_AF_ASSERT_5 = 0x5 , EVENTID_AF_ASSERT_6 = 0x6 , EVENTID_AF_UNEXPECTED_ASSERT = 0x7 }
	Event IDs. More...

Protected Member Functions
	AssertFatalAdapterComponentBase (const char *compName="")
	Construct AssertFatalAdapterComponentBase object.

virtual	~AssertFatalAdapterComponentBase ()
	Destroy AssertFatalAdapterComponentBase object.

NATIVE_INT_TYPE	getNum_Log_OutputPorts ()

NATIVE_INT_TYPE	getNum_Time_OutputPorts ()

bool	isConnected_Log_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_Time_OutputPort (NATIVE_INT_TYPE portNum)

void	log_FATAL_AF_ASSERT_0 (const Fw::LogStringArg &file, U32 line)

void	log_FATAL_AF_ASSERT_1 (const Fw::LogStringArg &file, U32 line, U32 arg1)

void	log_FATAL_AF_ASSERT_2 (const Fw::LogStringArg &file, U32 line, U32 arg1, U32 arg2)

void	log_FATAL_AF_ASSERT_3 (const Fw::LogStringArg &file, U32 line, U32 arg1, U32 arg2, U32 arg3)

void	log_FATAL_AF_ASSERT_4 (const Fw::LogStringArg &file, U32 line, U32 arg1, U32 arg2, U32 arg3, U32 arg4)

void	log_FATAL_AF_ASSERT_5 (const Fw::LogStringArg &file, U32 line, U32 arg1, U32 arg2, U32 arg3, U32 arg4, U32 arg5)

void	log_FATAL_AF_ASSERT_6 (const Fw::LogStringArg &file, U32 line, U32 arg1, U32 arg2, U32 arg3, U32 arg4, U32 arg5, U32 arg6)

void	log_FATAL_AF_UNEXPECTED_ASSERT (const Fw::LogStringArg &file, U32 line, U32 numArgs)

Fw::Time	getTime ()

Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor.

virtual	~PassiveComponentBase ()
	Destructor.

void	init (NATIVE_INT_TYPE instance)
	Initialization function.

NATIVE_INT_TYPE	getInstance () const

Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor.

virtual	~ObjBase ()
	Destructor.

void	init ()
	Object initializer.

Friends
class	AssertFatalAdapterComponentBaseFriend
	Friend class for white-box testing.

Detailed Description

Auto-generated base for AssertFatalAdapter component.

A component for turning FW_ASSERTs into FATALs

Definition at line 27 of file AssertFatalAdapterComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOG_OUTPUT_PORTS
NUM_LOGTEXT_OUTPUT_PORTS
NUM_TIME_OUTPUT_PORTS

Definition at line 45 of file AssertFatalAdapterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_AF_ASSERT_0	An assert happened.
EVENTID_AF_ASSERT_1	An assert happened.
EVENTID_AF_ASSERT_2	An assert happened.
EVENTID_AF_ASSERT_3	An assert happened.
EVENTID_AF_ASSERT_4	An assert happened.
EVENTID_AF_ASSERT_5	An assert happened.
EVENTID_AF_ASSERT_6	An assert happened.
EVENTID_AF_UNEXPECTED_ASSERT	An unexpected assert happened.

Definition at line 52 of file AssertFatalAdapterComponentAc.hpp.

Constructor & Destructor Documentation

◆ AssertFatalAdapterComponentBase()

Svc::AssertFatalAdapterComponentBase::AssertFatalAdapterComponentBase ( const char * compName = "" )

protected

Construct AssertFatalAdapterComponentBase object.

Parameters

compName The component name

Definition at line 242 of file AssertFatalAdapterComponentAc.cpp.

◆ ~AssertFatalAdapterComponentBase()

Svc::AssertFatalAdapterComponentBase::~AssertFatalAdapterComponentBase ( )

protectedvirtual

Destroy AssertFatalAdapterComponentBase object.

Definition at line 249 of file AssertFatalAdapterComponentAc.cpp.

Member Function Documentation

◆ getNum_Log_OutputPorts()

NATIVE_INT_TYPE Svc::AssertFatalAdapterComponentBase::getNum_Log_OutputPorts ( )

protected

Get the number of Log output ports

Returns: The number of Log output ports

Definition at line 259 of file AssertFatalAdapterComponentAc.cpp.

◆ getNum_Time_OutputPorts()

NATIVE_INT_TYPE Svc::AssertFatalAdapterComponentBase::getNum_Time_OutputPorts ( )

protected

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 275 of file AssertFatalAdapterComponentAc.cpp.

◆ getTime()

Fw::Time Svc::AssertFatalAdapterComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 1614 of file AssertFatalAdapterComponentAc.cpp.

◆ init()

void Svc::AssertFatalAdapterComponentBase::init ( NATIVE_INT_TYPE instance = 0 )

Initialize AssertFatalAdapterComponentBase object.

Parameters

instance The instance number

Definition at line 62 of file AssertFatalAdapterComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::AssertFatalAdapterComponentBase::isConnected_Log_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port Log is connected

Returns: Whether port Log is connected

Parameters

portNum The port number

Definition at line 285 of file AssertFatalAdapterComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::AssertFatalAdapterComponentBase::isConnected_Time_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port Time is connected

Returns: Whether port Time is connected

Parameters

portNum The port number

Definition at line 311 of file AssertFatalAdapterComponentAc.cpp.

◆ log_FATAL_AF_ASSERT_0()

void Svc::AssertFatalAdapterComponentBase::log_FATAL_AF_ASSERT_0	(	const Fw::LogStringArg &	file,
		U32	line )

protected

Log event AF_ASSERT_0

An assert happened

Parameters

file	The source file of the assert
line	Line number of the assert

Definition at line 326 of file AssertFatalAdapterComponentAc.cpp.

◆ log_FATAL_AF_ASSERT_1()

void Svc::AssertFatalAdapterComponentBase::log_FATAL_AF_ASSERT_1	(	const Fw::LogStringArg &	file,
		U32	line,
		U32	arg1 )

protected

Log event AF_ASSERT_1

An assert happened

Parameters

file	The source file of the assert
line	Line number of the assert
arg1	First assert argument

Definition at line 437 of file AssertFatalAdapterComponentAc.cpp.

◆ log_FATAL_AF_ASSERT_2()

void Svc::AssertFatalAdapterComponentBase::log_FATAL_AF_ASSERT_2	(	const Fw::LogStringArg &	file,
		U32	line,
		U32	arg1,
		U32	arg2 )

protected

Log event AF_ASSERT_2

An assert happened

Parameters

file	The source file of the assert
line	Line number of the assert
arg1	First assert argument
arg2	Second assert argument

Definition at line 566 of file AssertFatalAdapterComponentAc.cpp.

◆ log_FATAL_AF_ASSERT_3()

void Svc::AssertFatalAdapterComponentBase::log_FATAL_AF_ASSERT_3	(	const Fw::LogStringArg &	file,
		U32	line,
		U32	arg1,
		U32	arg2,
		U32	arg3 )

protected

Log event AF_ASSERT_3

An assert happened

Parameters

file	The source file of the assert
line	Line number of the assert
arg1	First assert argument
arg2	Second assert argument
arg3	Third assert argument

Definition at line 713 of file AssertFatalAdapterComponentAc.cpp.

◆ log_FATAL_AF_ASSERT_4()

void Svc::AssertFatalAdapterComponentBase::log_FATAL_AF_ASSERT_4	(	const Fw::LogStringArg &	file,
		U32	line,
		U32	arg1,
		U32	arg2,
		U32	arg3,
		U32	arg4 )

protected

Log event AF_ASSERT_4

An assert happened

Parameters

file	The source file of the assert
line	Line number of the assert
arg1	First assert argument
arg2	Second assert argument
arg3	Third assert argument
arg4	Fourth assert argument

Definition at line 878 of file AssertFatalAdapterComponentAc.cpp.

◆ log_FATAL_AF_ASSERT_5()

void Svc::AssertFatalAdapterComponentBase::log_FATAL_AF_ASSERT_5	(	const Fw::LogStringArg &	file,
		U32	line,
		U32	arg1,
		U32	arg2,
		U32	arg3,
		U32	arg4,
		U32	arg5 )

protected

Log event AF_ASSERT_5

An assert happened

Parameters

file	The source file of the assert
line	Line number of the assert
arg1	First assert argument
arg2	Second assert argument
arg3	Third assert argument
arg4	Fourth assert argument
arg5	Fifth assert argument

Definition at line 1061 of file AssertFatalAdapterComponentAc.cpp.

◆ log_FATAL_AF_ASSERT_6()

void Svc::AssertFatalAdapterComponentBase::log_FATAL_AF_ASSERT_6	(	const Fw::LogStringArg &	file,
		U32	line,
		U32	arg1,
		U32	arg2,
		U32	arg3,
		U32	arg4,
		U32	arg5,
		U32	arg6 )

protected

Log event AF_ASSERT_6

An assert happened

Parameters

file	The source file of the assert
line	Line number of the assert
arg1	First assert argument
arg2	Second assert argument
arg3	Third assert argument
arg4	Fourth assert argument
arg5	Fifth assert argument
arg6	Sixth assert argument

Definition at line 1262 of file AssertFatalAdapterComponentAc.cpp.

◆ log_FATAL_AF_UNEXPECTED_ASSERT()

void Svc::AssertFatalAdapterComponentBase::log_FATAL_AF_UNEXPECTED_ASSERT	(	const Fw::LogStringArg &	file,
		U32	line,
		U32	numArgs )

protected

Log event AF_UNEXPECTED_ASSERT

An unexpected assert happened

Parameters

file	The source file of the assert
line	Line number of the assert
numArgs	Number of unexpected arguments

Definition at line 1481 of file AssertFatalAdapterComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::AssertFatalAdapterComponentBase::set_Log_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputLogPort *	port )

Connect port to Log[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 138 of file AssertFatalAdapterComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::AssertFatalAdapterComponentBase::set_Time_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputTimePort *	port )

Connect port to Time[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 170 of file AssertFatalAdapterComponentAc.cpp.

Friends And Related Symbol Documentation

◆ AssertFatalAdapterComponentBaseFriend

friend class AssertFatalAdapterComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 36 of file AssertFatalAdapterComponentAc.hpp.

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

docs-cache/F-Prime/Svc/AssertFatalAdapter/AssertFatalAdapterComponentAc.hpp
docs-cache/F-Prime/Svc/AssertFatalAdapter/AssertFatalAdapterComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ AssertFatalAdapterComponentBase()

◆ ~AssertFatalAdapterComponentBase()

Member Function Documentation

◆ getNum_Log_OutputPorts()

◆ getNum_Time_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_Log_OutputPort()

◆ isConnected_Time_OutputPort()

◆ log_FATAL_AF_ASSERT_0()

◆ log_FATAL_AF_ASSERT_1()

◆ log_FATAL_AF_ASSERT_2()

◆ log_FATAL_AF_ASSERT_3()

◆ log_FATAL_AF_ASSERT_4()

◆ log_FATAL_AF_ASSERT_5()

◆ log_FATAL_AF_ASSERT_6()

◆ log_FATAL_AF_UNEXPECTED_ASSERT()

◆ set_Log_OutputPort()

◆ set_Time_OutputPort()

Friends And Related Symbol Documentation

◆ AssertFatalAdapterComponentBaseFriend