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

#include <Svc/ComLogger/ComLoggerComponentAc.hpp>

Inheritance diagram for Svc::ComLoggerComponentBase:

Public Member Functions
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize ComLoggerComponentBase object. More...

Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)

Fw::InputComPort *	get_comIn_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)

void	set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
	Connect port to cmdRegOut[portNum]. More...

void	set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum]. More...

void	set_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to logOut[portNum]. More...

void	set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum]. More...

void	set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum]. More...

void	regCommands ()
	Register commands with the Command Dispatcher. More...

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_DEFAULT, FwSizeType stackSize=Os::Task::TASK_DEFAULT, FwSizeType cpuAffinity=Os::Task::TASK_DEFAULT, FwTaskIdType identifier=static_cast< FwTaskIdType >(Os::Task::TASK_DEFAULT))
	called by instantiator when task is to be started More...

void	exit ()
	exit task in active component More...

Os::Task::Status	join ()
	Join the thread. More...

	DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
	Join to thread with discarded value_ptr. More...

Public Member Functions inherited from Fw::QueuedComponentBase
void	deinit () override
	Allows de-initialization on teardown. More...

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

FwIdType	getIdBase () const

Protected Types
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...

enum	{ NUM_COMIN_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_LOGTEXT_OUTPUT_PORTS = 1, NUM_CMDREGOUT_OUTPUT_PORTS = 1, NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1, NUM_LOGOUT_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ OPCODE_CLOSEFILE = 0x0 }
	Command opcodes. More...

enum	{ EVENTID_FILEOPENERROR = 0x0, EVENTID_FILEWRITEERROR = 0x1, EVENTID_FILEVALIDATIONERROR = 0x2, EVENTID_FILECLOSED = 0x3, EVENTID_FILENOTINITIALIZED = 0x4 }
	Event IDs. More...

enum	{ EVENTID_FILENOTINITIALIZED_THROTTLE = 5 }
	Event throttle values: sets initial value of countdown variables. More...

Protected Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE }
	Tracks the lifecycle of the component. More...

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

virtual	~ComLoggerComponentBase ()
	Destroy ComLoggerComponentBase object. More...

bool	isConnected_cmdRegOut_OutputPort (FwIndexType portNum) const

bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) const

bool	isConnected_logOut_OutputPort (FwIndexType portNum) const

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum) const

bool	isConnected_pingOut_OutputPort (FwIndexType portNum) const

void	cmdIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
	Handler base-class function for input port cmdIn. More...

virtual void	comIn_handler (FwIndexType portNum, Fw::ComBuffer &data, U32 context)=0
	Handler for input port comIn. More...

virtual void	pingIn_handler (FwIndexType portNum, U32 key)=0
	Handler for input port pingIn. More...

void	comIn_handlerBase (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Handler base-class function for input port comIn. More...

void	pingIn_handlerBase (FwIndexType portNum, U32 key)
	Handler base-class function for input port pingIn. More...

virtual void	comIn_preMsgHook (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Pre-message hook for async input port comIn. More...

virtual void	pingIn_preMsgHook (FwIndexType portNum, U32 key)
	Pre-message hook for async input port pingIn. More...

void	pingOut_out (FwIndexType portNum, U32 key) const
	Invoke output port pingOut. More...

void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...

virtual void	CloseFile_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0

void	CloseFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

virtual void	CloseFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CloseFile. More...

void	log_WARNING_HI_FileOpenError (U32 errornum, const Fw::StringBase &file) const

void	log_WARNING_HI_FileWriteError (U32 errornum, U32 bytesWritten, U32 bytesToWrite, const Fw::StringBase &file) const

void	log_WARNING_LO_FileValidationError (const Fw::StringBase &validationFile, const Fw::StringBase &file, U32 status) const

void	log_DIAGNOSTIC_FileClosed (const Fw::StringBase &file) const

void	log_WARNING_LO_FileNotInitialized ()
	Log event FileNotInitialized. More...

void	log_WARNING_LO_FileNotInitialized_ThrottleClear ()
	Reset throttle value for FileNotInitialized. More...

Fw::Time	getTime () const

Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...

virtual	~ActiveComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	initialization code More...

virtual void	preamble ()
	A function that will be called before the event loop is entered. More...

MsgDispatchStatus	dispatch ()
	The function that will dispatching messages. More...

virtual void	finalizer ()
	A function that will be called after exiting the loop. More...

Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor. More...

virtual	~QueuedComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	initialization function More...

Os::Queue::Status	createQueue (FwSizeType depth, FwSizeType msgSize)

MsgDispatchStatus	dispatchAvailableMessages ()
	dispatches all messages currently in the queue, returning status of the dispatch More...

FwSizeType	getNumMsgsDropped ()
	return number of messages dropped More...

void	incNumMsgDropped ()
	increment the number of messages dropped More...

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

virtual	~PassiveComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	Initialization function. More...

FwEnumStoreType	getInstance () const

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

virtual	~ObjBase ()
	Destructor. More...

void	init ()
	Object initializer. More...

Static Protected Member Functions
static constexpr FwIndexType	getNum_cmdIn_InputPorts ()

static constexpr FwIndexType	getNum_comIn_InputPorts ()

static constexpr FwIndexType	getNum_pingIn_InputPorts ()

static constexpr FwIndexType	getNum_cmdRegOut_OutputPorts ()

static constexpr FwIndexType	getNum_cmdResponseOut_OutputPorts ()

static constexpr FwIndexType	getNum_logOut_OutputPorts ()

static constexpr FwIndexType	getNum_timeCaller_OutputPorts ()

static constexpr FwIndexType	getNum_pingOut_OutputPorts ()

Friends
class	ComLoggerTesterBase
	Friend class tester to support autocoded test harness. More...

class	ComLoggerTester
	Friend class tester implementation to support white-box testing. More...

Additional Inherited Members
Public Types inherited from Fw::ActiveComponentBase
enum	{ ACTIVE_COMPONENT_EXIT }

Public Types inherited from Fw::QueuedComponentBase
enum	MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT }

Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task	m_task
	task object for active component More...

Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component More...

Detailed Description

Auto-generated base for ComLogger component.

A component for logging Com buffers

Definition at line 40 of file ComLoggerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 60 of file ComLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_COMIN_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS

Definition at line 65 of file ComLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOGTEXT_OUTPUT_PORTS
NUM_CMDREGOUT_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_LOGOUT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS

Definition at line 71 of file ComLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 80 of file ComLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_CLOSEFILE	Forces a close of the currently opened file.

Definition at line 85 of file ComLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_FILEOPENERROR	The ComLogger encountered an error opening a file.
EVENTID_FILEWRITEERROR	The ComLogger encountered an error writing to a file.
EVENTID_FILEVALIDATIONERROR	The ComLogger encountered an error writing the validation file.
EVENTID_FILECLOSED	The ComLogger successfully closed a file on command.
EVENTID_FILENOTINITIALIZED

Definition at line 90 of file ComLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_FILENOTINITIALIZED_THROTTLE	Throttle reset count for FileNotInitialized.

Definition at line 99 of file ComLoggerComponentAc.hpp.

Constructor & Destructor Documentation

◆ ComLoggerComponentBase()

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

protected

Construct ComLoggerComponentBase object.

Parameters

compName The component name

Definition at line 573 of file ComLoggerComponentAc.cpp.

◆ ~ComLoggerComponentBase()

Svc::ComLoggerComponentBase::~ComLoggerComponentBase ( )

protectedvirtual

Destroy ComLoggerComponentBase object.

Definition at line 580 of file ComLoggerComponentAc.cpp.

Member Function Documentation

◆ CloseFile_cmdHandler()

virtual void Svc::ComLoggerComponentBase::CloseFile_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedpure virtual

Handler for command CloseFile

Forces a close of the currently opened file.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ CloseFile_cmdHandlerBase()

void Svc::ComLoggerComponentBase::CloseFile_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command CloseFile

Forces a close of the currently opened file.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 903 of file ComLoggerComponentAc.cpp.

◆ CloseFile_preMsgHook()

void Svc::ComLoggerComponentBase::CloseFile_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command CloseFile.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 970 of file ComLoggerComponentAc.cpp.

◆ cmdIn_handlerBase()

void Svc::ComLoggerComponentBase::cmdIn_handlerBase	(	FwIndexType	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Handler base-class function for input port cmdIn.

Parameters

portNum	The port number
opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 678 of file ComLoggerComponentAc.cpp.

◆ cmdResponse_out()

void Svc::ComLoggerComponentBase::cmdResponse_out	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdResponse	response
	)

protected

Emit command response.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
response	The command response

Definition at line 886 of file ComLoggerComponentAc.cpp.

◆ comIn_handler()

virtual void Svc::ComLoggerComponentBase::comIn_handler	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protectedpure virtual

Handler for input port comIn.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

◆ comIn_handlerBase()

void Svc::ComLoggerComponentBase::comIn_handlerBase	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protected

Handler base-class function for input port comIn.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 712 of file ComLoggerComponentAc.cpp.

◆ comIn_preMsgHook()

void Svc::ComLoggerComponentBase::comIn_preMsgHook	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protectedvirtual

Pre-message hook for async input port comIn.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 835 of file ComLoggerComponentAc.cpp.

◆ get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::ComLoggerComponentBase::get_cmdIn_InputPort ( FwIndexType portNum )

Get special input port at index

Returns: cmdIn[portNum]

Parameters

portNum The port number

Definition at line 303 of file ComLoggerComponentAc.cpp.

◆ get_comIn_InputPort()

Fw::InputComPort * Svc::ComLoggerComponentBase::get_comIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: comIn[portNum]

Parameters

portNum The port number

Definition at line 322 of file ComLoggerComponentAc.cpp.

◆ get_pingIn_InputPort()

Svc::InputPingPort * Svc::ComLoggerComponentBase::get_pingIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 333 of file ComLoggerComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

static constexpr FwIndexType Svc::ComLoggerComponentBase::getNum_cmdIn_InputPorts ( )

inlinestaticprotected

Get the number of cmdIn input ports

Returns: The number of cmdIn input ports

Definition at line 310 of file ComLoggerComponentAc.hpp.

◆ getNum_cmdRegOut_OutputPorts()

static constexpr FwIndexType Svc::ComLoggerComponentBase::getNum_cmdRegOut_OutputPorts ( )

inlinestaticprotected

Get the number of cmdRegOut output ports

Returns: The number of cmdRegOut output ports

Definition at line 354 of file ComLoggerComponentAc.hpp.

◆ getNum_cmdResponseOut_OutputPorts()

static constexpr FwIndexType Svc::ComLoggerComponentBase::getNum_cmdResponseOut_OutputPorts ( )

inlinestaticprotected

Get the number of cmdResponseOut output ports

Returns: The number of cmdResponseOut output ports

Definition at line 361 of file ComLoggerComponentAc.hpp.

◆ getNum_comIn_InputPorts()

static constexpr FwIndexType Svc::ComLoggerComponentBase::getNum_comIn_InputPorts ( )

inlinestaticprotected

Get the number of comIn input ports

Returns: The number of comIn input ports

Definition at line 323 of file ComLoggerComponentAc.hpp.

◆ getNum_logOut_OutputPorts()

static constexpr FwIndexType Svc::ComLoggerComponentBase::getNum_logOut_OutputPorts ( )

inlinestaticprotected

Get the number of logOut output ports

Returns: The number of logOut output ports

Definition at line 368 of file ComLoggerComponentAc.hpp.

◆ getNum_pingIn_InputPorts()

static constexpr FwIndexType Svc::ComLoggerComponentBase::getNum_pingIn_InputPorts ( )

inlinestaticprotected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 330 of file ComLoggerComponentAc.hpp.

◆ getNum_pingOut_OutputPorts()

static constexpr FwIndexType Svc::ComLoggerComponentBase::getNum_pingOut_OutputPorts ( )

inlinestaticprotected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 388 of file ComLoggerComponentAc.hpp.

◆ getNum_timeCaller_OutputPorts()

static constexpr FwIndexType Svc::ComLoggerComponentBase::getNum_timeCaller_OutputPorts ( )

inlinestaticprotected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 375 of file ComLoggerComponentAc.hpp.

◆ getTime()

Fw::Time Svc::ComLoggerComponentBase::getTime ( ) const

protected

Get the time

\return The current time

Definition at line 1480 of file ComLoggerComponentAc.cpp.

◆ init()

void Svc::ComLoggerComponentBase::init	(	FwSizeType	queueDepth,
		FwEnumStoreType	instance = `0`
	)

Initialize ComLoggerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 73 of file ComLoggerComponentAc.cpp.

◆ isConnected_cmdRegOut_OutputPort()

bool Svc::ComLoggerComponentBase::isConnected_cmdRegOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port cmdRegOut is connected

Returns: Whether port cmdRegOut is connected

Parameters

portNum The port number

Definition at line 607 of file ComLoggerComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::ComLoggerComponentBase::isConnected_cmdResponseOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port cmdResponseOut is connected

Returns: Whether port cmdResponseOut is connected

Parameters

portNum The port number

Definition at line 618 of file ComLoggerComponentAc.cpp.

◆ isConnected_logOut_OutputPort()

bool Svc::ComLoggerComponentBase::isConnected_logOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port logOut is connected

Returns: Whether port logOut is connected

Parameters

portNum The port number

Definition at line 629 of file ComLoggerComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::ComLoggerComponentBase::isConnected_pingOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port pingOut is connected

Returns: Whether port pingOut is connected

Parameters

portNum The port number

Definition at line 659 of file ComLoggerComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::ComLoggerComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType portNum ) const

protected

Check whether port timeCaller is connected

Returns: Whether port timeCaller is connected

Parameters

portNum The port number

Definition at line 640 of file ComLoggerComponentAc.cpp.

◆ log_DIAGNOSTIC_FileClosed()

void Svc::ComLoggerComponentBase::log_DIAGNOSTIC_FileClosed ( const Fw::StringBase & file ) const

protected

Log event FileClosed

The ComLogger successfully closed a file on command.

Parameters

file The file

Definition at line 1317 of file ComLoggerComponentAc.cpp.

◆ log_WARNING_HI_FileOpenError()

void Svc::ComLoggerComponentBase::log_WARNING_HI_FileOpenError	(	U32	errornum,
		const Fw::StringBase &	file
	)		const

protected

Log event FileOpenError

The ComLogger encountered an error opening a file

Parameters

errornum	The error number returned from open file
file	The file

Definition at line 985 of file ComLoggerComponentAc.cpp.

◆ log_WARNING_HI_FileWriteError()

void Svc::ComLoggerComponentBase::log_WARNING_HI_FileWriteError	(	U32	errornum,
		U32	bytesWritten,
		U32	bytesToWrite,
		const Fw::StringBase &	file
	)		const

protected

Log event FileWriteError

The ComLogger encountered an error writing to a file

Parameters

errornum	The error number returned from write file
bytesWritten	The number of bytes successfully written to file
bytesToWrite	The number of bytes attempted to write to file
file	The file

Definition at line 1080 of file ComLoggerComponentAc.cpp.

◆ log_WARNING_LO_FileNotInitialized()

void Svc::ComLoggerComponentBase::log_WARNING_LO_FileNotInitialized ( )

protected

Log event FileNotInitialized.

Definition at line 1392 of file ComLoggerComponentAc.cpp.

◆ log_WARNING_LO_FileNotInitialized_ThrottleClear()

void Svc::ComLoggerComponentBase::log_WARNING_LO_FileNotInitialized_ThrottleClear ( )

protected

Reset throttle value for FileNotInitialized.

Definition at line 1469 of file ComLoggerComponentAc.cpp.

◆ log_WARNING_LO_FileValidationError()

void Svc::ComLoggerComponentBase::log_WARNING_LO_FileValidationError	(	const Fw::StringBase &	validationFile,
		const Fw::StringBase &	file,
		U32	status
	)		const

protected

Log event FileValidationError

The ComLogger encountered an error writing the validation file

Parameters

validationFile	The validation file
file	The file
status	The Os::Validate::Status return

Definition at line 1211 of file ComLoggerComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::ComLoggerComponentBase::pingIn_handler	(	FwIndexType	portNum,
		U32	key
	)

protectedpure virtual

Handler for input port pingIn.

Parameters

portNum	The port number
key	Value to return to pinger

◆ pingIn_handlerBase()

void Svc::ComLoggerComponentBase::pingIn_handlerBase	(	FwIndexType	portNum,
		U32	key
	)

protected

Handler base-class function for input port pingIn.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 774 of file ComLoggerComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::ComLoggerComponentBase::pingIn_preMsgHook	(	FwIndexType	portNum,
		U32	key
	)

protectedvirtual

Pre-message hook for async input port pingIn.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 845 of file ComLoggerComponentAc.cpp.

◆ pingOut_out()

void Svc::ComLoggerComponentBase::pingOut_out	(	FwIndexType	portNum,
		U32	key
	)		const

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 860 of file ComLoggerComponentAc.cpp.

◆ regCommands()

void Svc::ComLoggerComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 558 of file ComLoggerComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

void Svc::ComLoggerComponentBase::set_cmdRegOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdRegPort *	port
	)

Connect port to cmdRegOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 370 of file ComLoggerComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

void Svc::ComLoggerComponentBase::set_cmdResponseOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdResponsePort *	port
	)

Connect port to cmdResponseOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 384 of file ComLoggerComponentAc.cpp.

◆ set_logOut_OutputPort()

void Svc::ComLoggerComponentBase::set_logOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputLogPort *	port
	)

Connect port to logOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 398 of file ComLoggerComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::ComLoggerComponentBase::set_pingOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputPingPort *	port
	)

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 434 of file ComLoggerComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::ComLoggerComponentBase::set_timeCaller_OutputPort	(	FwIndexType	portNum,
		Fw::InputTimePort *	port
	)

Connect port to timeCaller[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 412 of file ComLoggerComponentAc.cpp.

Friends And Related Function Documentation

◆ ComLoggerTester

friend class ComLoggerTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 51 of file ComLoggerComponentAc.hpp.

◆ ComLoggerTesterBase

friend class ComLoggerTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 49 of file ComLoggerComponentAc.hpp.

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

Svc/ComLogger/ComLoggerComponentAc.hpp
Svc/ComLogger/ComLoggerComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ ComLoggerComponentBase()

◆ ~ComLoggerComponentBase()

Member Function Documentation

◆ CloseFile_cmdHandler()

◆ CloseFile_cmdHandlerBase()

◆ CloseFile_preMsgHook()

◆ cmdIn_handlerBase()

◆ cmdResponse_out()

◆ comIn_handler()

◆ comIn_handlerBase()

◆ comIn_preMsgHook()

◆ get_cmdIn_InputPort()

◆ get_comIn_InputPort()

◆ get_pingIn_InputPort()

◆ getNum_cmdIn_InputPorts()

◆ getNum_cmdRegOut_OutputPorts()

◆ getNum_cmdResponseOut_OutputPorts()

◆ getNum_comIn_InputPorts()

◆ getNum_logOut_OutputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_cmdRegOut_OutputPort()

◆ isConnected_cmdResponseOut_OutputPort()

◆ isConnected_logOut_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ log_DIAGNOSTIC_FileClosed()

◆ log_WARNING_HI_FileOpenError()

◆ log_WARNING_HI_FileWriteError()

◆ log_WARNING_LO_FileNotInitialized()

◆ log_WARNING_LO_FileNotInitialized_ThrottleClear()

◆ log_WARNING_LO_FileValidationError()

◆ pingIn_handler()

◆ pingIn_handlerBase()

◆ pingIn_preMsgHook()

◆ pingOut_out()

◆ regCommands()

◆ set_cmdRegOut_OutputPort()

◆ set_cmdResponseOut_OutputPort()

◆ set_logOut_OutputPort()

◆ set_pingOut_OutputPort()

◆ set_timeCaller_OutputPort()

Friends And Related Function Documentation

◆ ComLoggerTester

◆ ComLoggerTesterBase