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

#include <Svc/ComLogger/ComLoggerComponentAc.hpp>

Inheritance diagram for Svc::ComLoggerComponentBase:

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

Fw::InputCmdPort *	get_cmdIn_InputPort (NATIVE_INT_TYPE portNum)

Fw::InputComPort *	get_comIn_InputPort (NATIVE_INT_TYPE portNum)

Svc::InputPingPort *	get_pingIn_InputPort (NATIVE_INT_TYPE portNum)

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

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

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

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

void	set_pingOut_OutputPort (NATIVE_INT_TYPE 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 (NATIVE_UINT_TYPE priority=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE stackSize=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE cpuAffinity=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE identifier=Os::Task::TASK_DEFAULT)
	called by instantiator when task is to be started More...

	DEPRECATED (void start(NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1), "Please switch to start(NATIVE_UINT_TYPE priority, NATIVE_UINT_TYPE stackSize, NATIVE_UINT_TYPE cpuAffinity, NATIVE_UINT_TYPE identifier)")
	called by instantiator when task is to be started More...

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

Os::Task::TaskStatus	join (void **value_ptr)
	provide return value of thread if value_ptr is not NULL More...

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

U32	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 Member Functions
	ComLoggerComponentBase (const char *compName="")
	Construct ComLoggerComponentBase object. More...

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

NATIVE_INT_TYPE	getNum_cmdIn_InputPorts () const

NATIVE_INT_TYPE	getNum_comIn_InputPorts () const

NATIVE_INT_TYPE	getNum_pingIn_InputPorts () const

NATIVE_INT_TYPE	getNum_cmdRegOut_OutputPorts () const

NATIVE_INT_TYPE	getNum_cmdResponseOut_OutputPorts () const

NATIVE_INT_TYPE	getNum_logOut_OutputPorts () const

NATIVE_INT_TYPE	getNum_timeCaller_OutputPorts () const

NATIVE_INT_TYPE	getNum_pingOut_OutputPorts () const

bool	isConnected_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_logOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_timeCaller_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)

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

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

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

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

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

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

void	pingOut_out (NATIVE_INT_TYPE portNum, U32 key)
	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::LogStringArg &file)

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

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

void	log_DIAGNOSTIC_FileClosed (const Fw::LogStringArg &file)

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

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

Fw::Time	getTime ()

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

virtual	~ActiveComponentBase ()
	Destructor. More...

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

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

virtual void	loop ()
	The function that will loop 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 (NATIVE_INT_TYPE instance)
	initialization function More...

Os::Queue::QueueStatus	createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)

NATIVE_INT_TYPE	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 (NATIVE_INT_TYPE instance)
	Initialization function. More...

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

Friends
class	ComLoggerComponentBaseFriend
	Friend class for 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 33 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 51 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 56 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 62 of file ComLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 71 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 76 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 81 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 90 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 610 of file ComLoggerComponentAc.cpp.

◆ ~ComLoggerComponentBase()

Svc::ComLoggerComponentBase::~ComLoggerComponentBase ( )

protectedvirtual

Destroy ComLoggerComponentBase object.

Definition at line 617 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 963 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 1030 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 946 of file ComLoggerComponentAc.cpp.

◆ comIn_handler()

virtual void Svc::ComLoggerComponentBase::comIn_handler	(	NATIVE_INT_TYPE	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	(	NATIVE_INT_TYPE	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 781 of file ComLoggerComponentAc.cpp.

◆ comIn_preMsgHook()

void Svc::ComLoggerComponentBase::comIn_preMsgHook	(	NATIVE_INT_TYPE	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 904 of file ComLoggerComponentAc.cpp.

◆ get_cmdIn_InputPort()

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

Get special input port at index

Returns: cmdIn[portNum]

Parameters

portNum The port number

Definition at line 355 of file ComLoggerComponentAc.cpp.

◆ get_comIn_InputPort()

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

Get typed input port at index

Returns: comIn[portNum]

Parameters

portNum The port number

Definition at line 370 of file ComLoggerComponentAc.cpp.

◆ get_pingIn_InputPort()

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

Get typed input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 381 of file ComLoggerComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

NATIVE_INT_TYPE Svc::ComLoggerComponentBase::getNum_cmdIn_InputPorts ( ) const

protected

Get the number of cmdIn input ports

Returns: The number of cmdIn input ports

Definition at line 627 of file ComLoggerComponentAc.cpp.

◆ getNum_cmdRegOut_OutputPorts()

NATIVE_INT_TYPE Svc::ComLoggerComponentBase::getNum_cmdRegOut_OutputPorts ( ) const

protected

Get the number of cmdRegOut output ports

Returns: The number of cmdRegOut output ports

Definition at line 663 of file ComLoggerComponentAc.cpp.

◆ getNum_cmdResponseOut_OutputPorts()

NATIVE_INT_TYPE Svc::ComLoggerComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const

protected

Get the number of cmdResponseOut output ports

Returns: The number of cmdResponseOut output ports

Definition at line 669 of file ComLoggerComponentAc.cpp.

◆ getNum_comIn_InputPorts()

NATIVE_INT_TYPE Svc::ComLoggerComponentBase::getNum_comIn_InputPorts ( ) const

protected

Get the number of comIn input ports

Returns: The number of comIn input ports

Definition at line 637 of file ComLoggerComponentAc.cpp.

◆ getNum_logOut_OutputPorts()

NATIVE_INT_TYPE Svc::ComLoggerComponentBase::getNum_logOut_OutputPorts ( ) const

protected

Get the number of logOut output ports

Returns: The number of logOut output ports

Definition at line 675 of file ComLoggerComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

NATIVE_INT_TYPE Svc::ComLoggerComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 643 of file ComLoggerComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

NATIVE_INT_TYPE Svc::ComLoggerComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 691 of file ComLoggerComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

NATIVE_INT_TYPE Svc::ComLoggerComponentBase::getNum_timeCaller_OutputPorts ( ) const

protected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 681 of file ComLoggerComponentAc.cpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 1555 of file ComLoggerComponentAc.cpp.

◆ init()

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

Initialize ComLoggerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 72 of file ComLoggerComponentAc.cpp.

◆ isConnected_cmdRegOut_OutputPort()

bool Svc::ComLoggerComponentBase::isConnected_cmdRegOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port cmdRegOut is connected

Returns: Whether port cmdRegOut is connected

Parameters

portNum The port number

Definition at line 716 of file ComLoggerComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::ComLoggerComponentBase::isConnected_cmdResponseOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port cmdResponseOut is connected

Returns: Whether port cmdResponseOut is connected

Parameters

portNum The port number

Definition at line 727 of file ComLoggerComponentAc.cpp.

◆ isConnected_logOut_OutputPort()

bool Svc::ComLoggerComponentBase::isConnected_logOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port logOut is connected

Returns: Whether port logOut is connected

Parameters

portNum The port number

Definition at line 738 of file ComLoggerComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::ComLoggerComponentBase::isConnected_pingOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port pingOut is connected

Returns: Whether port pingOut is connected

Parameters

portNum The port number

Definition at line 764 of file ComLoggerComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::ComLoggerComponentBase::isConnected_timeCaller_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port timeCaller is connected

Returns: Whether port timeCaller is connected

Parameters

portNum The port number

Definition at line 749 of file ComLoggerComponentAc.cpp.

◆ log_DIAGNOSTIC_FileClosed()

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

protected

Log event FileClosed

The ComLogger successfully closed a file on command.

Parameters

file The file

Definition at line 1383 of file ComLoggerComponentAc.cpp.

◆ log_WARNING_HI_FileOpenError()

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

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 1045 of file ComLoggerComponentAc.cpp.

◆ log_WARNING_HI_FileWriteError()

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

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 1143 of file ComLoggerComponentAc.cpp.

◆ log_WARNING_LO_FileNotInitialized()

void Svc::ComLoggerComponentBase::log_WARNING_LO_FileNotInitialized ( )

protected

Log event FileNotInitialized.

Definition at line 1461 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 1544 of file ComLoggerComponentAc.cpp.

◆ log_WARNING_LO_FileValidationError()

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

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 1277 of file ComLoggerComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::ComLoggerComponentBase::pingIn_handler	(	NATIVE_INT_TYPE	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	(	NATIVE_INT_TYPE	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 843 of file ComLoggerComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::ComLoggerComponentBase::pingIn_preMsgHook	(	NATIVE_INT_TYPE	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 914 of file ComLoggerComponentAc.cpp.

◆ pingOut_out()

void Svc::ComLoggerComponentBase::pingOut_out	(	NATIVE_INT_TYPE	portNum,
		U32	key
	)

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 927 of file ComLoggerComponentAc.cpp.

◆ regCommands()

void Svc::ComLoggerComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 596 of file ComLoggerComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

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

Connect port to cmdRegOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 414 of file ComLoggerComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

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

Connect port to cmdResponseOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 428 of file ComLoggerComponentAc.cpp.

◆ set_logOut_OutputPort()

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

Connect port to logOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 442 of file ComLoggerComponentAc.cpp.

◆ set_pingOut_OutputPort()

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

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 474 of file ComLoggerComponentAc.cpp.

◆ set_timeCaller_OutputPort()

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

Connect port to timeCaller[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 456 of file ComLoggerComponentAc.cpp.

Friends And Related Function Documentation

◆ ComLoggerComponentBaseFriend

friend class ComLoggerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 42 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

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()

◆ 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

◆ ComLoggerComponentBaseFriend