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

#include <Svc/FileDispatcher/FileDispatcherComponentAc.hpp>

Inheritance diagram for Svc::FileDispatcherComponentBase:

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

Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)

Svc::InputFileAnnouncePort *	get_fileAnnounceRecv_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_fileDispatch_OutputPort (FwIndexType portNum, Svc::InputFileDispatchPort *port)
	Connect port to fileDispatch[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_FILEANNOUNCERECV_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

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

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

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

enum	{ EVENTID_FILEDISPATCHSTATE = 0x0, EVENTID_FILEDISPATCHED = 0x1, EVENTID_FILEDISPATCHPORTNOTCONNECTED = 0x2 }
	Event IDs. More...

enum	{ EVENTID_FILEDISPATCHPORTNOTCONNECTED_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
	FileDispatcherComponentBase (const char *compName="")
	Construct FileDispatcherComponentBase object. More...

virtual	~FileDispatcherComponentBase ()
	Destroy FileDispatcherComponentBase 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_fileDispatch_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	fileAnnounceRecv_handler (FwIndexType portNum, Fw::StringBase &file_name)=0
	Handler for input port fileAnnounceRecv. More...

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

void	fileAnnounceRecv_handlerBase (FwIndexType portNum, Fw::StringBase &file_name)
	Handler base-class function for input port fileAnnounceRecv. More...

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

virtual void	fileAnnounceRecv_preMsgHook (FwIndexType portNum, Fw::StringBase &file_name)
	Pre-message hook for async input port fileAnnounceRecv. More...

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

void	fileDispatch_out (FwIndexType portNum, Fw::StringBase &file_name) const
	Invoke output port fileDispatch. 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	ENABLE_DISPATCH_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Svc::FileDispatcherCfg::FileDispatchPort &file_type, const Fw::Enabled &enable)=0
	Handler for command ENABLE_DISPATCH. More...

void	ENABLE_DISPATCH_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
	Base-class handler function for command ENABLE_DISPATCH. More...

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

void	log_ACTIVITY_HI_FileDispatchState (const Svc::FileDispatcherCfg::FileDispatchPort &file_type, const Fw::Enabled &enabled) const
	Log event FileDispatchState. More...

void	log_ACTIVITY_HI_FileDispatched (const Fw::StringBase &file_name, const Svc::FileDispatcherCfg::FileDispatchPort &file_type) const
	Log event FileDispatched. More...

void	log_WARNING_LO_FileDispatchPortNotConnected (const Fw::StringBase &file_name, const Svc::FileDispatcherCfg::FileDispatchPort &file_type)
	Log event FileDispatchPortNotConnected. More...

void	log_WARNING_LO_FileDispatchPortNotConnected_ThrottleClear ()
	Reset throttle value for FileDispatchPortNotConnected. 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_fileAnnounceRecv_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_fileDispatch_OutputPorts ()

static constexpr FwIndexType	getNum_pingOut_OutputPorts ()

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

class	FileDispatcherTester
	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 FileDispatcher component.

Component to dispatch uplinked files to various services

Definition at line 41 of file FileDispatcherComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 61 of file FileDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_FILEANNOUNCERECV_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS

Definition at line 66 of file FileDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGOUT_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_LOGOUT_OUTPUT_PORTS
NUM_LOGTEXTOUT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS

Definition at line 72 of file FileDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_FILEDISPATCH_OUTPUT_PORTS
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 81 of file FileDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_ENABLE_DISPATCH

Definition at line 87 of file FileDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_FILEDISPATCHSTATE
EVENTID_FILEDISPATCHED
EVENTID_FILEDISPATCHPORTNOTCONNECTED

Definition at line 92 of file FileDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_FILEDISPATCHPORTNOTCONNECTED_THROTTLE	Throttle reset count for FileDispatchPortNotConnected.

Definition at line 99 of file FileDispatcherComponentAc.hpp.

Constructor & Destructor Documentation

◆ FileDispatcherComponentBase()

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

protected

Construct FileDispatcherComponentBase object.

Parameters

compName The component name

Definition at line 614 of file FileDispatcherComponentAc.cpp.

◆ ~FileDispatcherComponentBase()

Svc::FileDispatcherComponentBase::~FileDispatcherComponentBase ( )

protectedvirtual

Destroy FileDispatcherComponentBase object.

Definition at line 621 of file FileDispatcherComponentAc.cpp.

Member Function Documentation

◆ cmdIn_handlerBase()

void Svc::FileDispatcherComponentBase::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 730 of file FileDispatcherComponentAc.cpp.

◆ cmdResponse_out()

void Svc::FileDispatcherComponentBase::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 948 of file FileDispatcherComponentAc.cpp.

◆ ENABLE_DISPATCH_cmdHandler()

virtual void Svc::FileDispatcherComponentBase::ENABLE_DISPATCH_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		const Svc::FileDispatcherCfg::FileDispatchPort &	file_type,
		const Fw::Enabled &	enable
	)

protectedpure virtual

Handler for command ENABLE_DISPATCH.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
file_type	the file type dispatch to enable/disable

◆ ENABLE_DISPATCH_cmdHandlerBase()

void Svc::FileDispatcherComponentBase::ENABLE_DISPATCH_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command ENABLE_DISPATCH.

Parameters

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

Definition at line 965 of file FileDispatcherComponentAc.cpp.

◆ ENABLE_DISPATCH_preMsgHook()

void Svc::FileDispatcherComponentBase::ENABLE_DISPATCH_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command ENABLE_DISPATCH.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1032 of file FileDispatcherComponentAc.cpp.

◆ fileAnnounceRecv_handler()

virtual void Svc::FileDispatcherComponentBase::fileAnnounceRecv_handler	(	FwIndexType	portNum,
		Fw::StringBase &	file_name
	)

protectedpure virtual

Handler for input port fileAnnounceRecv.

Parameters

portNum	The port number
file_name	The successfully uplinked file

◆ fileAnnounceRecv_handlerBase()

void Svc::FileDispatcherComponentBase::fileAnnounceRecv_handlerBase	(	FwIndexType	portNum,
		Fw::StringBase &	file_name
	)

protected

Handler base-class function for input port fileAnnounceRecv.

Parameters

portNum	The port number
file_name	The successfully uplinked file

Definition at line 764 of file FileDispatcherComponentAc.cpp.

◆ fileAnnounceRecv_preMsgHook()

void Svc::FileDispatcherComponentBase::fileAnnounceRecv_preMsgHook	(	FwIndexType	portNum,
		Fw::StringBase &	file_name
	)

protectedvirtual

Pre-message hook for async input port fileAnnounceRecv.

Parameters

portNum	The port number
file_name	The successfully uplinked file

Definition at line 878 of file FileDispatcherComponentAc.cpp.

◆ fileDispatch_out()

void Svc::FileDispatcherComponentBase::fileDispatch_out	(	FwIndexType	portNum,
		Fw::StringBase &	file_name
	)		const

protected

Invoke output port fileDispatch.

Parameters

portNum	The port number
file_name	The file to dispatch

Definition at line 902 of file FileDispatcherComponentAc.cpp.

◆ get_cmdIn_InputPort()

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

Get special input port at index

Returns: cmdIn[portNum]

Parameters

portNum The port number

Definition at line 316 of file FileDispatcherComponentAc.cpp.

◆ get_fileAnnounceRecv_InputPort()

Svc::InputFileAnnouncePort * Svc::FileDispatcherComponentBase::get_fileAnnounceRecv_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: fileAnnounceRecv[portNum]

Parameters

portNum The port number

Definition at line 335 of file FileDispatcherComponentAc.cpp.

◆ get_pingIn_InputPort()

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

Get typed input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 346 of file FileDispatcherComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

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

inlinestaticprotected

Get the number of cmdIn input ports

Returns: The number of cmdIn input ports

Definition at line 322 of file FileDispatcherComponentAc.hpp.

◆ getNum_cmdRegOut_OutputPorts()

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

inlinestaticprotected

Get the number of cmdRegOut output ports

Returns: The number of cmdRegOut output ports

Definition at line 355 of file FileDispatcherComponentAc.hpp.

◆ getNum_cmdResponseOut_OutputPorts()

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

inlinestaticprotected

Get the number of cmdResponseOut output ports

Returns: The number of cmdResponseOut output ports

Definition at line 362 of file FileDispatcherComponentAc.hpp.

◆ getNum_fileAnnounceRecv_InputPorts()

static constexpr FwIndexType Svc::FileDispatcherComponentBase::getNum_fileAnnounceRecv_InputPorts ( )

inlinestaticprotected

Get the number of fileAnnounceRecv input ports

Returns: The number of fileAnnounceRecv input ports

Definition at line 335 of file FileDispatcherComponentAc.hpp.

◆ getNum_fileDispatch_OutputPorts()

static constexpr FwIndexType Svc::FileDispatcherComponentBase::getNum_fileDispatch_OutputPorts ( )

inlinestaticprotected

Get the number of fileDispatch output ports

Returns: The number of fileDispatch output ports

Definition at line 400 of file FileDispatcherComponentAc.hpp.

◆ getNum_logOut_OutputPorts()

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

inlinestaticprotected

Get the number of logOut output ports

Returns: The number of logOut output ports

Definition at line 369 of file FileDispatcherComponentAc.hpp.

◆ getNum_pingIn_InputPorts()

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

inlinestaticprotected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 342 of file FileDispatcherComponentAc.hpp.

◆ getNum_pingOut_OutputPorts()

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

inlinestaticprotected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 407 of file FileDispatcherComponentAc.hpp.

◆ getNum_timeCaller_OutputPorts()

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

inlinestaticprotected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 387 of file FileDispatcherComponentAc.hpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 1373 of file FileDispatcherComponentAc.cpp.

◆ init()

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

Initialize FileDispatcherComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 65 of file FileDispatcherComponentAc.cpp.

◆ isConnected_cmdRegOut_OutputPort()

bool Svc::FileDispatcherComponentBase::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 633 of file FileDispatcherComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::FileDispatcherComponentBase::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 644 of file FileDispatcherComponentAc.cpp.

◆ isConnected_fileDispatch_OutputPort()

bool Svc::FileDispatcherComponentBase::isConnected_fileDispatch_OutputPort ( FwIndexType portNum ) const

protected

Check whether port fileDispatch is connected

Returns: Whether port fileDispatch is connected

Parameters

portNum The port number

Definition at line 700 of file FileDispatcherComponentAc.cpp.

◆ isConnected_logOut_OutputPort()

bool Svc::FileDispatcherComponentBase::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 655 of file FileDispatcherComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::FileDispatcherComponentBase::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 711 of file FileDispatcherComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::FileDispatcherComponentBase::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 681 of file FileDispatcherComponentAc.cpp.

◆ log_ACTIVITY_HI_FileDispatched()

void Svc::FileDispatcherComponentBase::log_ACTIVITY_HI_FileDispatched	(	const Fw::StringBase &	file_name,
		const Svc::FileDispatcherCfg::FileDispatchPort &	file_type
	)		const

protected

Log event FileDispatched.

Definition at line 1154 of file FileDispatcherComponentAc.cpp.

◆ log_ACTIVITY_HI_FileDispatchState()

void Svc::FileDispatcherComponentBase::log_ACTIVITY_HI_FileDispatchState	(	const Svc::FileDispatcherCfg::FileDispatchPort &	file_type,
		const Fw::Enabled &	enabled
	)		const

protected

Log event FileDispatchState.

Definition at line 1047 of file FileDispatcherComponentAc.cpp.

◆ log_WARNING_LO_FileDispatchPortNotConnected()

void Svc::FileDispatcherComponentBase::log_WARNING_LO_FileDispatchPortNotConnected	(	const Fw::StringBase &	file_name,
		const Svc::FileDispatcherCfg::FileDispatchPort &	file_type
	)

protected

Log event FileDispatchPortNotConnected.

Definition at line 1252 of file FileDispatcherComponentAc.cpp.

◆ log_WARNING_LO_FileDispatchPortNotConnected_ThrottleClear()

void Svc::FileDispatcherComponentBase::log_WARNING_LO_FileDispatchPortNotConnected_ThrottleClear ( )

protected

Reset throttle value for FileDispatchPortNotConnected.

Definition at line 1362 of file FileDispatcherComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::FileDispatcherComponentBase::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::FileDispatcherComponentBase::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 817 of file FileDispatcherComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::FileDispatcherComponentBase::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 887 of file FileDispatcherComponentAc.cpp.

◆ pingOut_out()

void Svc::FileDispatcherComponentBase::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 922 of file FileDispatcherComponentAc.cpp.

◆ regCommands()

void Svc::FileDispatcherComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 599 of file FileDispatcherComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

void Svc::FileDispatcherComponentBase::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 365 of file FileDispatcherComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

void Svc::FileDispatcherComponentBase::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 379 of file FileDispatcherComponentAc.cpp.

◆ set_fileDispatch_OutputPort()

void Svc::FileDispatcherComponentBase::set_fileDispatch_OutputPort	(	FwIndexType	portNum,
		Svc::InputFileDispatchPort *	port
	)

Connect port to fileDispatch[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 447 of file FileDispatcherComponentAc.cpp.

◆ set_logOut_OutputPort()

void Svc::FileDispatcherComponentBase::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 393 of file FileDispatcherComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::FileDispatcherComponentBase::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 461 of file FileDispatcherComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::FileDispatcherComponentBase::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 425 of file FileDispatcherComponentAc.cpp.

Friends And Related Function Documentation

◆ FileDispatcherTester

friend class FileDispatcherTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 52 of file FileDispatcherComponentAc.hpp.

◆ FileDispatcherTesterBase

friend class FileDispatcherTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 50 of file FileDispatcherComponentAc.hpp.

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

Svc/FileDispatcher/FileDispatcherComponentAc.hpp
Svc/FileDispatcher/FileDispatcherComponentAc.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

◆ FileDispatcherComponentBase()

◆ ~FileDispatcherComponentBase()

Member Function Documentation

◆ cmdIn_handlerBase()

◆ cmdResponse_out()

◆ ENABLE_DISPATCH_cmdHandler()

◆ ENABLE_DISPATCH_cmdHandlerBase()

◆ ENABLE_DISPATCH_preMsgHook()

◆ fileAnnounceRecv_handler()

◆ fileAnnounceRecv_handlerBase()

◆ fileAnnounceRecv_preMsgHook()

◆ fileDispatch_out()

◆ get_cmdIn_InputPort()

◆ get_fileAnnounceRecv_InputPort()

◆ get_pingIn_InputPort()

◆ getNum_cmdIn_InputPorts()

◆ getNum_cmdRegOut_OutputPorts()

◆ getNum_cmdResponseOut_OutputPorts()

◆ getNum_fileAnnounceRecv_InputPorts()

◆ getNum_fileDispatch_OutputPorts()

◆ getNum_logOut_OutputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_cmdRegOut_OutputPort()

◆ isConnected_cmdResponseOut_OutputPort()

◆ isConnected_fileDispatch_OutputPort()

◆ isConnected_logOut_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ log_ACTIVITY_HI_FileDispatched()

◆ log_ACTIVITY_HI_FileDispatchState()

◆ log_WARNING_LO_FileDispatchPortNotConnected()

◆ log_WARNING_LO_FileDispatchPortNotConnected_ThrottleClear()

◆ pingIn_handler()

◆ pingIn_handlerBase()

◆ pingIn_preMsgHook()

◆ pingOut_out()

◆ regCommands()

◆ set_cmdRegOut_OutputPort()

◆ set_cmdResponseOut_OutputPort()

◆ set_fileDispatch_OutputPort()

◆ set_logOut_OutputPort()

◆ set_pingOut_OutputPort()

◆ set_timeCaller_OutputPort()

Friends And Related Function Documentation

◆ FileDispatcherTester

◆ FileDispatcherTesterBase