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

#include <Svc/BufferLogger/BufferLoggerComponentAc.hpp>

Inheritance diagram for Svc::BufferLoggerComponentBase:

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

Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)

Fw::InputBufferSendPort *	get_bufferSendIn_InputPort (FwIndexType portNum)

Fw::InputComPort *	get_comIn_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)

Svc::InputSchedPort *	get_schedIn_InputPort (FwIndexType portNum)

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

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

void	set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to eventOut[portNum].

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

void	set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
	Connect port to tlmOut[portNum].

void	set_bufferSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to bufferSendOut[portNum].

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

void	regCommands ()
	Register commands with the Command Dispatcher.

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT)
	called by instantiator when task is to be started

void	exit ()
	exit task in active component

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

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

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

U32	getIdBase () const

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

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

enum	{ NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUTTEXT_OUTPUT_PORTS = 1 , NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

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

enum	{ OPCODE_BL_OPENFILE = 0x0 , OPCODE_BL_CLOSEFILE = 0x1 , OPCODE_BL_SETLOGGING = 0x2 , OPCODE_BL_FLUSHFILE = 0x3 }
	Command opcodes. More...

enum	{ EVENTID_BL_LOGFILECLOSED = 0x0 , EVENTID_BL_LOGFILEOPENERROR = 0x1 , EVENTID_BL_LOGFILEVALIDATIONERROR = 0x2 , EVENTID_BL_LOGFILEWRITEERROR = 0x3 , EVENTID_BL_ACTIVATED = 0x4 , EVENTID_BL_DEACTIVATED = 0x5 , EVENTID_BL_NOLOGFILEOPENINITERROR = 0x6 }
	Event IDs. More...

enum	{ CHANNELID_BUFFERLOGGER_NUMLOGGEDBUFFERS = 0x0 }
	Channel IDs. More...

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

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

virtual	~BufferLoggerComponentBase ()
	Destroy BufferLoggerComponentBase object.

FwIndexType	getNum_cmdIn_InputPorts () const

FwIndexType	getNum_bufferSendIn_InputPorts () const

FwIndexType	getNum_comIn_InputPorts () const

FwIndexType	getNum_pingIn_InputPorts () const

FwIndexType	getNum_schedIn_InputPorts () const

FwIndexType	getNum_cmdRegOut_OutputPorts () const

FwIndexType	getNum_cmdResponseOut_OutputPorts () const

FwIndexType	getNum_eventOut_OutputPorts () const

FwIndexType	getNum_timeCaller_OutputPorts () const

FwIndexType	getNum_tlmOut_OutputPorts () const

FwIndexType	getNum_bufferSendOut_OutputPorts () const

FwIndexType	getNum_pingOut_OutputPorts () const

bool	isConnected_cmdRegOut_OutputPort (FwIndexType portNum)

bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum)

bool	isConnected_eventOut_OutputPort (FwIndexType portNum)

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)

bool	isConnected_tlmOut_OutputPort (FwIndexType portNum)

bool	isConnected_bufferSendOut_OutputPort (FwIndexType portNum)

bool	isConnected_pingOut_OutputPort (FwIndexType portNum)

virtual void	bufferSendIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port bufferSendIn.

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

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

virtual void	schedIn_handler (FwIndexType portNum, U32 context)=0
	Handler for input port schedIn.

void	bufferSendIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferSendIn.

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

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

void	schedIn_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port schedIn.

virtual void	bufferSendIn_preMsgHook (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Pre-message hook for async input port bufferSendIn.

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

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

virtual void	schedIn_preMsgHook (FwIndexType portNum, U32 context)
	Pre-message hook for async input port schedIn.

void	bufferSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Invoke output port bufferSendOut.

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

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

virtual void	BL_OpenFile_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &file)=0

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

virtual void	BL_SetLogging_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Svc::BufferLogger_LogState state)=0

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

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

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

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

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

virtual void	BL_OpenFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command BL_OpenFile.

virtual void	BL_CloseFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command BL_CloseFile.

virtual void	BL_SetLogging_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command BL_SetLogging.

virtual void	BL_FlushFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command BL_FlushFile.

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

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

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

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

void	log_ACTIVITY_LO_BL_Activated () const

void	log_ACTIVITY_LO_BL_Deactivated () const

void	log_WARNING_HI_BL_NoLogFileOpenInitError () const

void	tlmWrite_BufferLogger_NumLoggedBuffers (U32 arg, Fw::Time _tlmTime=Fw::Time()) const

Fw::Time	getTime ()

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

virtual	~ActiveComponentBase ()
	Destructor.

void	init (NATIVE_INT_TYPE instance)
	initialization code

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

MsgDispatchStatus	dispatch ()
	The function that will dispatching messages.

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

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

virtual	~QueuedComponentBase ()
	Destructor.

void	init (NATIVE_INT_TYPE instance)
	initialization function

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

NATIVE_INT_TYPE	getNumMsgsDropped ()
	return number of messages dropped

void	incNumMsgDropped ()
	increment the number of messages dropped

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	BufferLoggerComponentBaseFriend
	Friend class for white-box testing.

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

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

Detailed Description

Auto-generated base for BufferLogger component.

Definition at line 36 of file BufferLoggerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 54 of file BufferLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_BUFFERSENDIN_INPUT_PORTS
NUM_COMIN_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS
NUM_SCHEDIN_INPUT_PORTS

Definition at line 59 of file BufferLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGOUT_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_EVENTOUT_OUTPUT_PORTS
NUM_EVENTOUTTEXT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 67 of file BufferLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_BUFFERSENDOUT_OUTPUT_PORTS
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 77 of file BufferLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_BL_OPENFILE	Open a new log file with specified name; also resets unique file counter to 0.
OPCODE_BL_CLOSEFILE	Close the currently open log file, if any.
OPCODE_BL_SETLOGGING	Sets the volatile logging state.
OPCODE_BL_FLUSHFILE	Flushes the current open log file to disk; a no-op with fprime's unbuffered file I/O, so always returns success.

Definition at line 83 of file BufferLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_BL_LOGFILECLOSED	The Buffer Logger closed a log file.
EVENTID_BL_LOGFILEOPENERROR	The Buffer Logger encountered an error opening a log file.
EVENTID_BL_LOGFILEVALIDATIONERROR	The Buffer Logger encountered an error writing a validation file.
EVENTID_BL_LOGFILEWRITEERROR	The Buffer Logger encountered an error writing to a log file.
EVENTID_BL_ACTIVATED	Buffer logger was activated.
EVENTID_BL_DEACTIVATED	Buffer logger was deactivated.
EVENTID_BL_NOLOGFILEOPENINITERROR	No log file open command was received by BufferLogger.

Definition at line 91 of file BufferLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_BUFFERLOGGER_NUMLOGGEDBUFFERS	Channel ID for BufferLogger_NumLoggedBuffers.

Definition at line 102 of file BufferLoggerComponentAc.hpp.

Constructor & Destructor Documentation

◆ BufferLoggerComponentBase()

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

protected

Construct BufferLoggerComponentBase object.

Parameters

compName The component name

Definition at line 722 of file BufferLoggerComponentAc.cpp.

◆ ~BufferLoggerComponentBase()

Svc::BufferLoggerComponentBase::~BufferLoggerComponentBase ( )

protectedvirtual

Destroy BufferLoggerComponentBase object.

Definition at line 729 of file BufferLoggerComponentAc.cpp.

Member Function Documentation

◆ BL_CloseFile_cmdHandler()

virtual void Svc::BufferLoggerComponentBase::BL_CloseFile_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedpure virtual

Handler for command BL_CloseFile

Close the currently open log file, if any

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ BL_CloseFile_cmdHandlerBase()

void Svc::BufferLoggerComponentBase::BL_CloseFile_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command BL_CloseFile

Close the currently open log file, if any

Parameters

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

Definition at line 1319 of file BufferLoggerComponentAc.cpp.

◆ BL_CloseFile_preMsgHook()

void Svc::BufferLoggerComponentBase::BL_CloseFile_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command BL_CloseFile.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1515 of file BufferLoggerComponentAc.cpp.

◆ BL_FlushFile_cmdHandler()

virtual void Svc::BufferLoggerComponentBase::BL_FlushFile_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedpure virtual

Handler for command BL_FlushFile

Flushes the current open log file to disk; a no-op with fprime's unbuffered file I/O, so always returns success

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ BL_FlushFile_cmdHandlerBase()

void Svc::BufferLoggerComponentBase::BL_FlushFile_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command BL_FlushFile

Flushes the current open log file to disk; a no-op with fprime's unbuffered file I/O, so always returns success

Parameters

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

Definition at line 1437 of file BufferLoggerComponentAc.cpp.

◆ BL_FlushFile_preMsgHook()

void Svc::BufferLoggerComponentBase::BL_FlushFile_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command BL_FlushFile.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1537 of file BufferLoggerComponentAc.cpp.

◆ BL_OpenFile_cmdHandler()

virtual void Svc::BufferLoggerComponentBase::BL_OpenFile_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdStringArg &	file
	)

protectedpure virtual

Handler for command BL_OpenFile

Open a new log file with specified name; also resets unique file counter to 0

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ BL_OpenFile_cmdHandlerBase()

void Svc::BufferLoggerComponentBase::BL_OpenFile_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command BL_OpenFile

Open a new log file with specified name; also resets unique file counter to 0

Parameters

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

Definition at line 1260 of file BufferLoggerComponentAc.cpp.

◆ BL_OpenFile_preMsgHook()

void Svc::BufferLoggerComponentBase::BL_OpenFile_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command BL_OpenFile.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1504 of file BufferLoggerComponentAc.cpp.

◆ BL_SetLogging_cmdHandler()

virtual void Svc::BufferLoggerComponentBase::BL_SetLogging_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Svc::BufferLogger_LogState	state
	)

protectedpure virtual

Handler for command BL_SetLogging

Sets the volatile logging state

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ BL_SetLogging_cmdHandlerBase()

void Svc::BufferLoggerComponentBase::BL_SetLogging_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command BL_SetLogging

Sets the volatile logging state

Parameters

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

Definition at line 1378 of file BufferLoggerComponentAc.cpp.

◆ BL_SetLogging_preMsgHook()

void Svc::BufferLoggerComponentBase::BL_SetLogging_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command BL_SetLogging.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1526 of file BufferLoggerComponentAc.cpp.

◆ bufferSendIn_handler()

virtual void Svc::BufferLoggerComponentBase::bufferSendIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedpure virtual

Handler for input port bufferSendIn.

Parameters

portNum	The port number
fwBuffer	The buffer

◆ bufferSendIn_handlerBase()

void Svc::BufferLoggerComponentBase::bufferSendIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Handler base-class function for input port bufferSendIn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 939 of file BufferLoggerComponentAc.cpp.

◆ bufferSendIn_preMsgHook()

void Svc::BufferLoggerComponentBase::bufferSendIn_preMsgHook	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedvirtual

Pre-message hook for async input port bufferSendIn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1168 of file BufferLoggerComponentAc.cpp.

◆ bufferSendOut_out()

void Svc::BufferLoggerComponentBase::bufferSendOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Invoke output port bufferSendOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1209 of file BufferLoggerComponentAc.cpp.

◆ cmdResponse_out()

void Svc::BufferLoggerComponentBase::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 1243 of file BufferLoggerComponentAc.cpp.

◆ comIn_handler()

virtual void Svc::BufferLoggerComponentBase::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::BufferLoggerComponentBase::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 992 of file BufferLoggerComponentAc.cpp.

◆ comIn_preMsgHook()

void Svc::BufferLoggerComponentBase::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 1177 of file BufferLoggerComponentAc.cpp.

◆ get_bufferSendIn_InputPort()

Fw::InputBufferSendPort * Svc::BufferLoggerComponentBase::get_bufferSendIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: bufferSendIn[portNum]

Parameters

portNum The port number

Definition at line 392 of file BufferLoggerComponentAc.cpp.

◆ get_cmdIn_InputPort()

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

Get special input port at index

Returns: cmdIn[portNum]

Parameters

portNum The port number

Definition at line 377 of file BufferLoggerComponentAc.cpp.

◆ get_comIn_InputPort()

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

Get typed input port at index

Returns: comIn[portNum]

Parameters

portNum The port number

Definition at line 403 of file BufferLoggerComponentAc.cpp.

◆ get_pingIn_InputPort()

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

Get typed input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 414 of file BufferLoggerComponentAc.cpp.

◆ get_schedIn_InputPort()

Svc::InputSchedPort * Svc::BufferLoggerComponentBase::get_schedIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: schedIn[portNum]

Parameters

portNum The port number

Definition at line 425 of file BufferLoggerComponentAc.cpp.

◆ getNum_bufferSendIn_InputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_bufferSendIn_InputPorts ( ) const

protected

Get the number of bufferSendIn input ports

Returns: The number of bufferSendIn input ports

Definition at line 749 of file BufferLoggerComponentAc.cpp.

◆ getNum_bufferSendOut_OutputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_bufferSendOut_OutputPorts ( ) const

protected

Get the number of bufferSendOut output ports

Returns: The number of bufferSendOut output ports

Definition at line 821 of file BufferLoggerComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_cmdIn_InputPorts ( ) const

protected

Get the number of cmdIn input ports

Returns: The number of cmdIn input ports

Definition at line 739 of file BufferLoggerComponentAc.cpp.

◆ getNum_cmdRegOut_OutputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_cmdRegOut_OutputPorts ( ) const

protected

Get the number of cmdRegOut output ports

Returns: The number of cmdRegOut output ports

Definition at line 777 of file BufferLoggerComponentAc.cpp.

◆ getNum_cmdResponseOut_OutputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const

protected

Get the number of cmdResponseOut output ports

Returns: The number of cmdResponseOut output ports

Definition at line 783 of file BufferLoggerComponentAc.cpp.

◆ getNum_comIn_InputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_comIn_InputPorts ( ) const

protected

Get the number of comIn input ports

Returns: The number of comIn input ports

Definition at line 755 of file BufferLoggerComponentAc.cpp.

◆ getNum_eventOut_OutputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_eventOut_OutputPorts ( ) const

protected

Get the number of eventOut output ports

Returns: The number of eventOut output ports

Definition at line 789 of file BufferLoggerComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 761 of file BufferLoggerComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 827 of file BufferLoggerComponentAc.cpp.

◆ getNum_schedIn_InputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_schedIn_InputPorts ( ) const

protected

Get the number of schedIn input ports

Returns: The number of schedIn input ports

Definition at line 767 of file BufferLoggerComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_timeCaller_OutputPorts ( ) const

protected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 805 of file BufferLoggerComponentAc.cpp.

◆ getNum_tlmOut_OutputPorts()

FwIndexType Svc::BufferLoggerComponentBase::getNum_tlmOut_OutputPorts ( ) const

protected

Get the number of tlmOut output ports

Returns: The number of tlmOut output ports

Definition at line 811 of file BufferLoggerComponentAc.cpp.

◆ getTime()

Fw::Time Svc::BufferLoggerComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 2172 of file BufferLoggerComponentAc.cpp.

◆ init()

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

Initialize BufferLoggerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 79 of file BufferLoggerComponentAc.cpp.

◆ isConnected_bufferSendOut_OutputPort()

bool Svc::BufferLoggerComponentBase::isConnected_bufferSendOut_OutputPort ( FwIndexType portNum )

protected

Check whether port bufferSendOut is connected

Returns: Whether port bufferSendOut is connected

Parameters

portNum The port number

Definition at line 911 of file BufferLoggerComponentAc.cpp.

◆ isConnected_cmdRegOut_OutputPort()

bool Svc::BufferLoggerComponentBase::isConnected_cmdRegOut_OutputPort ( FwIndexType portNum )

protected

Check whether port cmdRegOut is connected

Returns: Whether port cmdRegOut is connected

Parameters

portNum The port number

Definition at line 837 of file BufferLoggerComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::BufferLoggerComponentBase::isConnected_cmdResponseOut_OutputPort ( FwIndexType portNum )

protected

Check whether port cmdResponseOut is connected

Returns: Whether port cmdResponseOut is connected

Parameters

portNum The port number

Definition at line 848 of file BufferLoggerComponentAc.cpp.

◆ isConnected_eventOut_OutputPort()

bool Svc::BufferLoggerComponentBase::isConnected_eventOut_OutputPort ( FwIndexType portNum )

protected

Check whether port eventOut is connected

Returns: Whether port eventOut is connected

Parameters

portNum The port number

Definition at line 859 of file BufferLoggerComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::BufferLoggerComponentBase::isConnected_pingOut_OutputPort ( FwIndexType portNum )

protected

Check whether port pingOut is connected

Returns: Whether port pingOut is connected

Parameters

portNum The port number

Definition at line 922 of file BufferLoggerComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::BufferLoggerComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType portNum )

protected

Check whether port timeCaller is connected

Returns: Whether port timeCaller is connected

Parameters

portNum The port number

Definition at line 885 of file BufferLoggerComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::BufferLoggerComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType portNum )

protected

Check whether port tlmOut is connected

Returns: Whether port tlmOut is connected

Parameters

portNum The port number

Definition at line 896 of file BufferLoggerComponentAc.cpp.

◆ log_ACTIVITY_LO_BL_Activated()

void Svc::BufferLoggerComponentBase::log_ACTIVITY_LO_BL_Activated ( ) const

protected

Log event BL_Activated

Buffer logger was activated

Definition at line 1936 of file BufferLoggerComponentAc.cpp.

◆ log_ACTIVITY_LO_BL_Deactivated()

void Svc::BufferLoggerComponentBase::log_ACTIVITY_LO_BL_Deactivated ( ) const

protected

Log event BL_Deactivated

Buffer logger was deactivated

Definition at line 2001 of file BufferLoggerComponentAc.cpp.

◆ log_DIAGNOSTIC_BL_LogFileClosed()

void Svc::BufferLoggerComponentBase::log_DIAGNOSTIC_BL_LogFileClosed ( const Fw::StringBase & file ) const

protected

Log event BL_LogFileClosed

The Buffer Logger closed a log file

Parameters

file The file

Definition at line 1552 of file BufferLoggerComponentAc.cpp.

◆ log_WARNING_HI_BL_LogFileOpenError()

void Svc::BufferLoggerComponentBase::log_WARNING_HI_BL_LogFileOpenError	(	U32	errornum,
		const Fw::StringBase &	file
	)		const

protected

Log event BL_LogFileOpenError

The Buffer Logger encountered an error opening a log file

Parameters

errornum	The error number returned from the open operation
file	The file

Definition at line 1624 of file BufferLoggerComponentAc.cpp.

◆ log_WARNING_HI_BL_LogFileValidationError()

void Svc::BufferLoggerComponentBase::log_WARNING_HI_BL_LogFileValidationError	(	const Fw::StringBase &	validationFile,
		U32	status
	)		const

protected

Log event BL_LogFileValidationError

The Buffer Logger encountered an error writing a validation file

Parameters

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

Definition at line 1716 of file BufferLoggerComponentAc.cpp.

◆ log_WARNING_HI_BL_LogFileWriteError()

void Svc::BufferLoggerComponentBase::log_WARNING_HI_BL_LogFileWriteError	(	U32	errornum,
		U32	bytesWritten,
		U32	bytesToWrite,
		const Fw::StringBase &	file
	)		const

protected

Log event BL_LogFileWriteError

The Buffer Logger encountered an error writing to a log file

Parameters

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

Definition at line 1808 of file BufferLoggerComponentAc.cpp.

◆ log_WARNING_HI_BL_NoLogFileOpenInitError()

void Svc::BufferLoggerComponentBase::log_WARNING_HI_BL_NoLogFileOpenInitError ( ) const

protected

Log event BL_NoLogFileOpenInitError

No log file open command was received by BufferLogger

Definition at line 2066 of file BufferLoggerComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::BufferLoggerComponentBase::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::BufferLoggerComponentBase::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 1054 of file BufferLoggerComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::BufferLoggerComponentBase::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 1187 of file BufferLoggerComponentAc.cpp.

◆ pingOut_out()

void Svc::BufferLoggerComponentBase::pingOut_out	(	FwIndexType	portNum,
		U32	key
	)

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1224 of file BufferLoggerComponentAc.cpp.

◆ regCommands()

void Svc::BufferLoggerComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 696 of file BufferLoggerComponentAc.cpp.

◆ schedIn_handler()

virtual void Svc::BufferLoggerComponentBase::schedIn_handler	(	FwIndexType	portNum,
		U32	context
	)

protectedpure virtual

Handler for input port schedIn.

Parameters

portNum	The port number
context	The call order

◆ schedIn_handlerBase()

void Svc::BufferLoggerComponentBase::schedIn_handlerBase	(	FwIndexType	portNum,
		U32	context
	)

protected

Handler base-class function for input port schedIn.

Parameters

portNum	The port number
context	The call order

Definition at line 1107 of file BufferLoggerComponentAc.cpp.

◆ schedIn_preMsgHook()

void Svc::BufferLoggerComponentBase::schedIn_preMsgHook	(	FwIndexType	portNum,
		U32	context
	)

protectedvirtual

Pre-message hook for async input port schedIn.

Parameters

portNum	The port number
context	The call order

Definition at line 1196 of file BufferLoggerComponentAc.cpp.

◆ set_bufferSendOut_OutputPort()

void Svc::BufferLoggerComponentBase::set_bufferSendOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to bufferSendOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 532 of file BufferLoggerComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

void Svc::BufferLoggerComponentBase::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 440 of file BufferLoggerComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

void Svc::BufferLoggerComponentBase::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 454 of file BufferLoggerComponentAc.cpp.

◆ set_eventOut_OutputPort()

void Svc::BufferLoggerComponentBase::set_eventOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputLogPort *	port
	)

Connect port to eventOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 468 of file BufferLoggerComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::BufferLoggerComponentBase::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 546 of file BufferLoggerComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::BufferLoggerComponentBase::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 500 of file BufferLoggerComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::BufferLoggerComponentBase::set_tlmOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputTlmPort *	port
	)

Connect port to tlmOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 514 of file BufferLoggerComponentAc.cpp.

◆ tlmWrite_BufferLogger_NumLoggedBuffers()

void Svc::BufferLoggerComponentBase::tlmWrite_BufferLogger_NumLoggedBuffers	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel BufferLogger_NumLoggedBuffers

The number of buffers logged

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 2135 of file BufferLoggerComponentAc.cpp.

Friends And Related Symbol Documentation

◆ BufferLoggerComponentBaseFriend

friend class BufferLoggerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 45 of file BufferLoggerComponentAc.hpp.

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

Svc/BufferLogger/BufferLoggerComponentAc.hpp
Svc/BufferLogger/BufferLoggerComponentAc.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

◆ BufferLoggerComponentBase()

◆ ~BufferLoggerComponentBase()

Member Function Documentation

◆ BL_CloseFile_cmdHandler()

◆ BL_CloseFile_cmdHandlerBase()

◆ BL_CloseFile_preMsgHook()

◆ BL_FlushFile_cmdHandler()

◆ BL_FlushFile_cmdHandlerBase()

◆ BL_FlushFile_preMsgHook()

◆ BL_OpenFile_cmdHandler()

◆ BL_OpenFile_cmdHandlerBase()

◆ BL_OpenFile_preMsgHook()

◆ BL_SetLogging_cmdHandler()

◆ BL_SetLogging_cmdHandlerBase()

◆ BL_SetLogging_preMsgHook()

◆ bufferSendIn_handler()

◆ bufferSendIn_handlerBase()

◆ bufferSendIn_preMsgHook()

◆ bufferSendOut_out()

◆ cmdResponse_out()

◆ comIn_handler()

◆ comIn_handlerBase()

◆ comIn_preMsgHook()

◆ get_bufferSendIn_InputPort()

◆ get_cmdIn_InputPort()

◆ get_comIn_InputPort()

◆ get_pingIn_InputPort()

◆ get_schedIn_InputPort()

◆ getNum_bufferSendIn_InputPorts()

◆ getNum_bufferSendOut_OutputPorts()

◆ getNum_cmdIn_InputPorts()

◆ getNum_cmdRegOut_OutputPorts()

◆ getNum_cmdResponseOut_OutputPorts()

◆ getNum_comIn_InputPorts()

◆ getNum_eventOut_OutputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_schedIn_InputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getNum_tlmOut_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_bufferSendOut_OutputPort()

◆ isConnected_cmdRegOut_OutputPort()

◆ isConnected_cmdResponseOut_OutputPort()

◆ isConnected_eventOut_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ isConnected_tlmOut_OutputPort()

◆ log_ACTIVITY_LO_BL_Activated()

◆ log_ACTIVITY_LO_BL_Deactivated()

◆ log_DIAGNOSTIC_BL_LogFileClosed()

◆ log_WARNING_HI_BL_LogFileOpenError()

◆ log_WARNING_HI_BL_LogFileValidationError()

◆ log_WARNING_HI_BL_LogFileWriteError()

◆ log_WARNING_HI_BL_NoLogFileOpenInitError()

◆ pingIn_handler()

◆ pingIn_handlerBase()

◆ pingIn_preMsgHook()

◆ pingOut_out()

◆ regCommands()

◆ schedIn_handler()

◆ schedIn_handlerBase()

◆ schedIn_preMsgHook()

◆ set_bufferSendOut_OutputPort()