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

#include <Svc/DpWriter/DpWriterComponentAc.hpp>

Inheritance diagram for Svc::DpWriterComponentBase:

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

Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)

Fw::InputBufferSendPort *	get_bufferSendIn_InputPort (FwIndexType portNum)

Svc::InputSchedPort *	get_schedIn_InputPort (FwIndexType portNum)

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

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

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

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

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

void	set_deallocBufferSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to deallocBufferSendOut[portNum]. More...

void	set_dpWrittenOut_OutputPort (FwIndexType portNum, Svc::InputDpWrittenPort *port)
	Connect port to dpWrittenOut[portNum]. More...

void	set_procBufferSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to procBufferSendOut[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_BUFFERSENDIN_INPUT_PORTS = 1, NUM_SCHEDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_CMDREGIN_OUTPUT_PORTS = 1, NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1, NUM_EVENTOUT_OUTPUT_PORTS = 1, NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1, NUM_TIMEGETOUT_OUTPUT_PORTS = 1, NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_DEALLOCBUFFERSENDOUT_OUTPUT_PORTS = 1, NUM_DPWRITTENOUT_OUTPUT_PORTS = 1, NUM_PROCBUFFERSENDOUT_OUTPUT_PORTS = 5 }
	Enumerations for numbers of typed output ports. More...

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

enum	{ EVENTID_INVALIDBUFFER = 0x0, EVENTID_BUFFERTOOSMALLFORPACKET = 0x1, EVENTID_INVALIDHEADERHASH = 0x2, EVENTID_INVALIDHEADER = 0x3, EVENTID_BUFFERTOOSMALLFORDATA = 0x4, EVENTID_FILEOPENERROR = 0x5, EVENTID_FILEWRITEERROR = 0x6, EVENTID_FILEWRITTEN = 0x7 }
	Event IDs. More...

enum	{ EVENTID_INVALIDBUFFER_THROTTLE = 10, EVENTID_BUFFERTOOSMALLFORPACKET_THROTTLE = 10, EVENTID_INVALIDHEADERHASH_THROTTLE = 10, EVENTID_INVALIDHEADER_THROTTLE = 10, EVENTID_BUFFERTOOSMALLFORDATA_THROTTLE = 10, EVENTID_FILEOPENERROR_THROTTLE = 10, EVENTID_FILEWRITEERROR_THROTTLE = 10 }
	Event throttle values: sets initial value of countdown variables. More...

enum	{ CHANNELID_NUMBUFFERSRECEIVED = 0x0, CHANNELID_NUMBYTESWRITTEN = 0x1, CHANNELID_NUMSUCCESSFULWRITES = 0x2, CHANNELID_NUMFAILEDWRITES = 0x3, CHANNELID_NUMERRORS = 0x4 }
	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
	DpWriterComponentBase (const char *compName="")
	Construct DpWriterComponentBase object. More...

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

bool	isConnected_cmdRegIn_OutputPort (FwIndexType portNum) const

bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) const

bool	isConnected_eventOut_OutputPort (FwIndexType portNum) const

bool	isConnected_timeGetOut_OutputPort (FwIndexType portNum) const

bool	isConnected_tlmOut_OutputPort (FwIndexType portNum) const

bool	isConnected_deallocBufferSendOut_OutputPort (FwIndexType portNum) const

bool	isConnected_dpWrittenOut_OutputPort (FwIndexType portNum) const

bool	isConnected_procBufferSendOut_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	bufferSendIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port bufferSendIn. More...

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

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

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

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

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

void	deallocBufferSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) const
	Invoke output port deallocBufferSendOut. More...

void	dpWrittenOut_out (FwIndexType portNum, const Fw::StringBase &fileName, FwDpPriorityType priority, FwSizeType size) const
	Invoke output port dpWrittenOut. More...

void	procBufferSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) const
	Invoke output port procBufferSendOut. More...

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

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

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

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

void	log_WARNING_HI_InvalidBuffer ()

void	log_WARNING_HI_BufferTooSmallForPacket (FwSizeType bufferSize, U32 minSize)

void	log_WARNING_HI_InvalidHeaderHash (FwSizeType bufferSize, U32 storedHash, U32 computedHash)

void	log_WARNING_HI_InvalidHeader (FwSizeType bufferSize, U32 errorCode)

void	log_WARNING_HI_BufferTooSmallForData (FwSizeType bufferSize, U32 minSize)

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

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

void	log_ACTIVITY_LO_FileWritten (U32 bytes, const Fw::StringBase &file) const

void	log_WARNING_HI_InvalidBuffer_ThrottleClear ()
	Reset throttle value for InvalidBuffer. More...

void	log_WARNING_HI_BufferTooSmallForPacket_ThrottleClear ()
	Reset throttle value for BufferTooSmallForPacket. More...

void	log_WARNING_HI_InvalidHeaderHash_ThrottleClear ()
	Reset throttle value for InvalidHeaderHash. More...

void	log_WARNING_HI_InvalidHeader_ThrottleClear ()
	Reset throttle value for InvalidHeader. More...

void	log_WARNING_HI_BufferTooSmallForData_ThrottleClear ()
	Reset throttle value for BufferTooSmallForData. More...

void	log_WARNING_HI_FileOpenError_ThrottleClear ()
	Reset throttle value for FileOpenError. More...

void	log_WARNING_HI_FileWriteError_ThrottleClear ()
	Reset throttle value for FileWriteError. More...

void	tlmWrite (FwChanIdType id, Fw::TlmBuffer &_tlmBuff, Fw::Time _tlmTime=Fw::Time()) const

void	tlmWrite_NumBuffersReceived (U32 arg, Fw::Time _tlmTime=Fw::Time())

void	tlmWrite_NumBytesWritten (U64 arg, Fw::Time _tlmTime=Fw::Time())

void	tlmWrite_NumSuccessfulWrites (U32 arg, Fw::Time _tlmTime=Fw::Time())

void	tlmWrite_NumFailedWrites (U32 arg, Fw::Time _tlmTime=Fw::Time())

void	tlmWrite_NumErrors (U32 arg, Fw::Time _tlmTime=Fw::Time())

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

static constexpr FwIndexType	getNum_schedIn_InputPorts ()

static constexpr FwIndexType	getNum_cmdRegIn_OutputPorts ()

static constexpr FwIndexType	getNum_cmdResponseOut_OutputPorts ()

static constexpr FwIndexType	getNum_eventOut_OutputPorts ()

static constexpr FwIndexType	getNum_timeGetOut_OutputPorts ()

static constexpr FwIndexType	getNum_tlmOut_OutputPorts ()

static constexpr FwIndexType	getNum_deallocBufferSendOut_OutputPorts ()

static constexpr FwIndexType	getNum_dpWrittenOut_OutputPorts ()

static constexpr FwIndexType	getNum_procBufferSendOut_OutputPorts ()

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

class	DpWriterTester
	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 DpWriter component.

A component for writing data products to disk

Definition at line 42 of file DpWriterComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 62 of file DpWriterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_BUFFERSENDIN_INPUT_PORTS
NUM_SCHEDIN_INPUT_PORTS

Definition at line 67 of file DpWriterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGIN_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_EVENTOUT_OUTPUT_PORTS
NUM_TEXTEVENTOUT_OUTPUT_PORTS
NUM_TIMEGETOUT_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 73 of file DpWriterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_DEALLOCBUFFERSENDOUT_OUTPUT_PORTS
NUM_DPWRITTENOUT_OUTPUT_PORTS
NUM_PROCBUFFERSENDOUT_OUTPUT_PORTS

Definition at line 83 of file DpWriterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_CLEAR_EVENT_THROTTLE	Clear event throttling.

Definition at line 90 of file DpWriterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_INVALIDBUFFER	Received buffer is invalid.
EVENTID_BUFFERTOOSMALLFORPACKET	Received buffer is too small to hold a data product packet.
EVENTID_INVALIDHEADERHASH	The received buffer has an invalid header hash.
EVENTID_INVALIDHEADER	Error occurred when deserializing the packet header.
EVENTID_BUFFERTOOSMALLFORDATA	Received buffer is too small to hold the data specified in the header.
EVENTID_FILEOPENERROR	An error occurred when opening a file.
EVENTID_FILEWRITEERROR	An error occurred when writing to a file.
EVENTID_FILEWRITTEN	File written.

Definition at line 95 of file DpWriterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_INVALIDBUFFER_THROTTLE	Throttle reset count for InvalidBuffer.
EVENTID_BUFFERTOOSMALLFORPACKET_THROTTLE	Throttle reset count for BufferTooSmallForPacket.
EVENTID_INVALIDHEADERHASH_THROTTLE	Throttle reset count for InvalidHeaderHash.
EVENTID_INVALIDHEADER_THROTTLE	Throttle reset count for InvalidHeader.
EVENTID_BUFFERTOOSMALLFORDATA_THROTTLE	Throttle reset count for BufferTooSmallForData.
EVENTID_FILEOPENERROR_THROTTLE	Throttle reset count for FileOpenError.
EVENTID_FILEWRITEERROR_THROTTLE	Throttle reset count for FileWriteError.

Definition at line 107 of file DpWriterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_NUMBUFFERSRECEIVED	Channel ID for NumBuffersReceived.
CHANNELID_NUMBYTESWRITTEN	Channel ID for NumBytesWritten.
CHANNELID_NUMSUCCESSFULWRITES	Channel ID for NumSuccessfulWrites.
CHANNELID_NUMFAILEDWRITES	Channel ID for NumFailedWrites.
CHANNELID_NUMERRORS	Channel ID for NumErrors.

Definition at line 118 of file DpWriterComponentAc.hpp.

Constructor & Destructor Documentation

◆ DpWriterComponentBase()

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

protected

Construct DpWriterComponentBase object.

Parameters

compName The component name

Definition at line 720 of file DpWriterComponentAc.cpp.

◆ ~DpWriterComponentBase()

Svc::DpWriterComponentBase::~DpWriterComponentBase ( )

protectedvirtual

Destroy DpWriterComponentBase object.

Definition at line 733 of file DpWriterComponentAc.cpp.

Member Function Documentation

◆ bufferSendIn_handler()

virtual void Svc::DpWriterComponentBase::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::DpWriterComponentBase::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 898 of file DpWriterComponentAc.cpp.

◆ bufferSendIn_preMsgHook()

void Svc::DpWriterComponentBase::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 1012 of file DpWriterComponentAc.cpp.

◆ CLEAR_EVENT_THROTTLE_cmdHandler()

virtual void Svc::DpWriterComponentBase::CLEAR_EVENT_THROTTLE_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedpure virtual

Handler for command CLEAR_EVENT_THROTTLE

Clear event throttling

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ CLEAR_EVENT_THROTTLE_cmdHandlerBase()

void Svc::DpWriterComponentBase::CLEAR_EVENT_THROTTLE_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command CLEAR_EVENT_THROTTLE

Clear event throttling

Parameters

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

Definition at line 1123 of file DpWriterComponentAc.cpp.

◆ CLEAR_EVENT_THROTTLE_preMsgHook()

void Svc::DpWriterComponentBase::CLEAR_EVENT_THROTTLE_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command CLEAR_EVENT_THROTTLE.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1190 of file DpWriterComponentAc.cpp.

◆ cmdIn_handlerBase()

void Svc::DpWriterComponentBase::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 864 of file DpWriterComponentAc.cpp.

◆ cmdResponse_out()

void Svc::DpWriterComponentBase::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 1106 of file DpWriterComponentAc.cpp.

◆ deallocBufferSendOut_out()

void Svc::DpWriterComponentBase::deallocBufferSendOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)		const

protected

Invoke output port deallocBufferSendOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1036 of file DpWriterComponentAc.cpp.

◆ dpWrittenOut_out()

void Svc::DpWriterComponentBase::dpWrittenOut_out	(	FwIndexType	portNum,
		const Fw::StringBase &	fileName,
		FwDpPriorityType	priority,
		FwSizeType	size
	)		const

protected

Invoke output port dpWrittenOut.

Parameters

portNum	The port number
fileName	The file name
priority	The priority
size	The file size

Definition at line 1056 of file DpWriterComponentAc.cpp.

◆ get_bufferSendIn_InputPort()

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

Get typed input port at index

Returns: bufferSendIn[portNum]

Parameters

portNum The port number

Definition at line 385 of file DpWriterComponentAc.cpp.

◆ get_cmdIn_InputPort()

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

Get special input port at index

Returns: cmdIn[portNum]

Parameters

portNum The port number

Definition at line 366 of file DpWriterComponentAc.cpp.

◆ get_schedIn_InputPort()

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

Get typed input port at index

Returns: schedIn[portNum]

Parameters

portNum The port number

Definition at line 396 of file DpWriterComponentAc.cpp.

◆ getNum_bufferSendIn_InputPorts()

static constexpr FwIndexType Svc::DpWriterComponentBase::getNum_bufferSendIn_InputPorts ( )

inlinestaticprotected

Get the number of bufferSendIn input ports

Returns: The number of bufferSendIn input ports

Definition at line 382 of file DpWriterComponentAc.hpp.

◆ getNum_cmdIn_InputPorts()

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

inlinestaticprotected

Get the number of cmdIn input ports

Returns: The number of cmdIn input ports

Definition at line 369 of file DpWriterComponentAc.hpp.

◆ getNum_cmdRegIn_OutputPorts()

static constexpr FwIndexType Svc::DpWriterComponentBase::getNum_cmdRegIn_OutputPorts ( )

inlinestaticprotected

Get the number of cmdRegIn output ports

Returns: The number of cmdRegIn output ports

Definition at line 402 of file DpWriterComponentAc.hpp.

◆ getNum_cmdResponseOut_OutputPorts()

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

inlinestaticprotected

Get the number of cmdResponseOut output ports

Returns: The number of cmdResponseOut output ports

Definition at line 409 of file DpWriterComponentAc.hpp.

◆ getNum_deallocBufferSendOut_OutputPorts()

static constexpr FwIndexType Svc::DpWriterComponentBase::getNum_deallocBufferSendOut_OutputPorts ( )

inlinestaticprotected

Get the number of deallocBufferSendOut output ports

Returns: The number of deallocBufferSendOut output ports

Definition at line 454 of file DpWriterComponentAc.hpp.

◆ getNum_dpWrittenOut_OutputPorts()

static constexpr FwIndexType Svc::DpWriterComponentBase::getNum_dpWrittenOut_OutputPorts ( )

inlinestaticprotected

Get the number of dpWrittenOut output ports

Returns: The number of dpWrittenOut output ports

Definition at line 461 of file DpWriterComponentAc.hpp.

◆ getNum_eventOut_OutputPorts()

static constexpr FwIndexType Svc::DpWriterComponentBase::getNum_eventOut_OutputPorts ( )

inlinestaticprotected

Get the number of eventOut output ports

Returns: The number of eventOut output ports

Definition at line 416 of file DpWriterComponentAc.hpp.

◆ getNum_procBufferSendOut_OutputPorts()

static constexpr FwIndexType Svc::DpWriterComponentBase::getNum_procBufferSendOut_OutputPorts ( )

inlinestaticprotected

Get the number of procBufferSendOut output ports

Returns: The number of procBufferSendOut output ports

Definition at line 468 of file DpWriterComponentAc.hpp.

◆ getNum_schedIn_InputPorts()

static constexpr FwIndexType Svc::DpWriterComponentBase::getNum_schedIn_InputPorts ( )

inlinestaticprotected

Get the number of schedIn input ports

Returns: The number of schedIn input ports

Definition at line 389 of file DpWriterComponentAc.hpp.

◆ getNum_timeGetOut_OutputPorts()

static constexpr FwIndexType Svc::DpWriterComponentBase::getNum_timeGetOut_OutputPorts ( )

inlinestaticprotected

Get the number of timeGetOut output ports

Returns: The number of timeGetOut output ports

Definition at line 434 of file DpWriterComponentAc.hpp.

◆ getNum_tlmOut_OutputPorts()

static constexpr FwIndexType Svc::DpWriterComponentBase::getNum_tlmOut_OutputPorts ( )

inlinestaticprotected

Get the number of tlmOut output ports

Returns: The number of tlmOut output ports

Definition at line 441 of file DpWriterComponentAc.hpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 2350 of file DpWriterComponentAc.cpp.

◆ init()

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

Initialize DpWriterComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 73 of file DpWriterComponentAc.cpp.

◆ isConnected_cmdRegIn_OutputPort()

bool Svc::DpWriterComponentBase::isConnected_cmdRegIn_OutputPort ( FwIndexType portNum ) const

protected

Check whether port cmdRegIn is connected

Returns: Whether port cmdRegIn is connected

Parameters

portNum The port number

Definition at line 745 of file DpWriterComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::DpWriterComponentBase::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 756 of file DpWriterComponentAc.cpp.

◆ isConnected_deallocBufferSendOut_OutputPort()

bool Svc::DpWriterComponentBase::isConnected_deallocBufferSendOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port deallocBufferSendOut is connected

Returns: Whether port deallocBufferSendOut is connected

Parameters

portNum The port number

Definition at line 823 of file DpWriterComponentAc.cpp.

◆ isConnected_dpWrittenOut_OutputPort()

bool Svc::DpWriterComponentBase::isConnected_dpWrittenOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port dpWrittenOut is connected

Returns: Whether port dpWrittenOut is connected

Parameters

portNum The port number

Definition at line 834 of file DpWriterComponentAc.cpp.

◆ isConnected_eventOut_OutputPort()

bool Svc::DpWriterComponentBase::isConnected_eventOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port eventOut is connected

Returns: Whether port eventOut is connected

Parameters

portNum The port number

Definition at line 767 of file DpWriterComponentAc.cpp.

◆ isConnected_procBufferSendOut_OutputPort()

bool Svc::DpWriterComponentBase::isConnected_procBufferSendOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port procBufferSendOut is connected

Returns: Whether port procBufferSendOut is connected

Parameters

portNum The port number

Definition at line 845 of file DpWriterComponentAc.cpp.

◆ isConnected_timeGetOut_OutputPort()

bool Svc::DpWriterComponentBase::isConnected_timeGetOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port timeGetOut is connected

Returns: Whether port timeGetOut is connected

Parameters

portNum The port number

Definition at line 793 of file DpWriterComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::DpWriterComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port tlmOut is connected

Returns: Whether port tlmOut is connected

Parameters

portNum The port number

Definition at line 804 of file DpWriterComponentAc.cpp.

◆ log_ACTIVITY_LO_FileWritten()

void Svc::DpWriterComponentBase::log_ACTIVITY_LO_FileWritten	(	U32	bytes,
		const Fw::StringBase &	file
	)		const

protected

Log event FileWritten

File written

Parameters

bytes	The number of bytes written
file	The file name

Definition at line 1978 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_BufferTooSmallForData()

void Svc::DpWriterComponentBase::log_WARNING_HI_BufferTooSmallForData	(	FwSizeType	bufferSize,
		U32	minSize
	)

protected

Log event BufferTooSmallForData

Received buffer is too small to hold the data specified in the header

Parameters

bufferSize	The incoming buffer size
minSize	The minimum required size

Definition at line 1626 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_BufferTooSmallForData_ThrottleClear()

void Svc::DpWriterComponentBase::log_WARNING_HI_BufferTooSmallForData_ThrottleClear ( )

protected

Reset throttle value for BufferTooSmallForData.

Definition at line 2105 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_BufferTooSmallForPacket()

void Svc::DpWriterComponentBase::log_WARNING_HI_BufferTooSmallForPacket	(	FwSizeType	bufferSize,
		U32	minSize
	)

protected

Log event BufferTooSmallForPacket

Received buffer is too small to hold a data product packet

Parameters

bufferSize	The incoming buffer size
minSize	The minimum required size

Definition at line 1278 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_BufferTooSmallForPacket_ThrottleClear()

void Svc::DpWriterComponentBase::log_WARNING_HI_BufferTooSmallForPacket_ThrottleClear ( )

protected

Reset throttle value for BufferTooSmallForPacket.

Definition at line 2084 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_FileOpenError()

void Svc::DpWriterComponentBase::log_WARNING_HI_FileOpenError	(	U32	status,
		const Fw::StringBase &	file
	)

protected

Log event FileOpenError

An error occurred when opening a file

Parameters

status	The status code returned from the open operation
file	The file

Definition at line 1736 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_FileOpenError_ThrottleClear()

void Svc::DpWriterComponentBase::log_WARNING_HI_FileOpenError_ThrottleClear ( )

protected

Reset throttle value for FileOpenError.

Definition at line 2112 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_FileWriteError()

void Svc::DpWriterComponentBase::log_WARNING_HI_FileWriteError	(	U32	status,
		U32	bytesWritten,
		U32	bytesToWrite,
		const Fw::StringBase &	file
	)

protected

Log event FileWriteError

An error occurred when writing to a file

Parameters

status	The status code returned from the write operation
bytesWritten	The number of bytes successfully written
bytesToWrite	The number of bytes attempted
file	The file

Definition at line 1839 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_FileWriteError_ThrottleClear()

void Svc::DpWriterComponentBase::log_WARNING_HI_FileWriteError_ThrottleClear ( )

protected

Reset throttle value for FileWriteError.

Definition at line 2119 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_InvalidBuffer()

void Svc::DpWriterComponentBase::log_WARNING_HI_InvalidBuffer ( )

protected

Log event InvalidBuffer

Received buffer is invalid

Definition at line 1205 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_InvalidBuffer_ThrottleClear()

void Svc::DpWriterComponentBase::log_WARNING_HI_InvalidBuffer_ThrottleClear ( )

protected

Reset throttle value for InvalidBuffer.

Definition at line 2077 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_InvalidHeader()

void Svc::DpWriterComponentBase::log_WARNING_HI_InvalidHeader	(	FwSizeType	bufferSize,
		U32	errorCode
	)

protected

Log event InvalidHeader

Error occurred when deserializing the packet header

Parameters

bufferSize	The incoming buffer size
errorCode	The error code

Definition at line 1516 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_InvalidHeader_ThrottleClear()

void Svc::DpWriterComponentBase::log_WARNING_HI_InvalidHeader_ThrottleClear ( )

protected

Reset throttle value for InvalidHeader.

Definition at line 2098 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_InvalidHeaderHash()

void Svc::DpWriterComponentBase::log_WARNING_HI_InvalidHeaderHash	(	FwSizeType	bufferSize,
		U32	storedHash,
		U32	computedHash
	)

protected

Log event InvalidHeaderHash

The received buffer has an invalid header hash

Parameters

bufferSize	The incoming buffer size
storedHash	The stored hash value
computedHash	The computed hash value

Definition at line 1388 of file DpWriterComponentAc.cpp.

◆ log_WARNING_HI_InvalidHeaderHash_ThrottleClear()

void Svc::DpWriterComponentBase::log_WARNING_HI_InvalidHeaderHash_ThrottleClear ( )

protected

Reset throttle value for InvalidHeaderHash.

Definition at line 2091 of file DpWriterComponentAc.cpp.

◆ procBufferSendOut_out()

void Svc::DpWriterComponentBase::procBufferSendOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)		const

protected

Invoke output port procBufferSendOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1080 of file DpWriterComponentAc.cpp.

◆ regCommands()

void Svc::DpWriterComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 705 of file DpWriterComponentAc.cpp.

◆ schedIn_handler()

virtual void Svc::DpWriterComponentBase::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::DpWriterComponentBase::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 951 of file DpWriterComponentAc.cpp.

◆ schedIn_preMsgHook()

void Svc::DpWriterComponentBase::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 1021 of file DpWriterComponentAc.cpp.

◆ set_cmdRegIn_OutputPort()

void Svc::DpWriterComponentBase::set_cmdRegIn_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdRegPort *	port
	)

Connect port to cmdRegIn[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 415 of file DpWriterComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

void Svc::DpWriterComponentBase::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 429 of file DpWriterComponentAc.cpp.

◆ set_deallocBufferSendOut_OutputPort()

void Svc::DpWriterComponentBase::set_deallocBufferSendOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to deallocBufferSendOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 511 of file DpWriterComponentAc.cpp.

◆ set_dpWrittenOut_OutputPort()

void Svc::DpWriterComponentBase::set_dpWrittenOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputDpWrittenPort *	port
	)

Connect port to dpWrittenOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 525 of file DpWriterComponentAc.cpp.

◆ set_eventOut_OutputPort()

void Svc::DpWriterComponentBase::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 443 of file DpWriterComponentAc.cpp.

◆ set_procBufferSendOut_OutputPort()

void Svc::DpWriterComponentBase::set_procBufferSendOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to procBufferSendOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 539 of file DpWriterComponentAc.cpp.

◆ set_timeGetOut_OutputPort()

void Svc::DpWriterComponentBase::set_timeGetOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputTimePort *	port
	)

Connect port to timeGetOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 475 of file DpWriterComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::DpWriterComponentBase::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 489 of file DpWriterComponentAc.cpp.

◆ tlmWrite()

void Svc::DpWriterComponentBase::tlmWrite	(	FwChanIdType	id,
		Fw::TlmBuffer &	_tlmBuff,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel given its local id and serialized value. Warning: This is a low level telemetry interface that does not guarentee channel type safety. It is up to the caller to make sure the serialized data matches the definition in the model. Update on change semantics are ignored, this telemetry is always written

Parameters

id	The channel id
_tlmBuff	The serialized telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 2130 of file DpWriterComponentAc.cpp.

◆ tlmWrite_NumBuffersReceived()

void Svc::DpWriterComponentBase::tlmWrite_NumBuffersReceived	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel NumBuffersReceived

The number of buffers received

Parameters

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

Definition at line 2161 of file DpWriterComponentAc.cpp.

◆ tlmWrite_NumBytesWritten()

void Svc::DpWriterComponentBase::tlmWrite_NumBytesWritten	(	U64	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel NumBytesWritten

The number of bytes written

Parameters

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

Definition at line 2198 of file DpWriterComponentAc.cpp.

◆ tlmWrite_NumErrors()

void Svc::DpWriterComponentBase::tlmWrite_NumErrors	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel NumErrors

The number of errors

Parameters

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

Definition at line 2309 of file DpWriterComponentAc.cpp.

◆ tlmWrite_NumFailedWrites()

void Svc::DpWriterComponentBase::tlmWrite_NumFailedWrites	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel NumFailedWrites

The number of failed writes

Parameters

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

Definition at line 2272 of file DpWriterComponentAc.cpp.

◆ tlmWrite_NumSuccessfulWrites()

void Svc::DpWriterComponentBase::tlmWrite_NumSuccessfulWrites	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel NumSuccessfulWrites

The number of successful writes

Parameters

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

Definition at line 2235 of file DpWriterComponentAc.cpp.

Friends And Related Function Documentation

◆ DpWriterTester

friend class DpWriterTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 53 of file DpWriterComponentAc.hpp.

◆ DpWriterTesterBase

friend class DpWriterTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 51 of file DpWriterComponentAc.hpp.

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

Svc/DpWriter/DpWriterComponentAc.hpp
Svc/DpWriter/DpWriterComponentAc.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

◆ anonymous enum

Constructor & Destructor Documentation

◆ DpWriterComponentBase()

◆ ~DpWriterComponentBase()

Member Function Documentation

◆ bufferSendIn_handler()

◆ bufferSendIn_handlerBase()

◆ bufferSendIn_preMsgHook()

◆ CLEAR_EVENT_THROTTLE_cmdHandler()

◆ CLEAR_EVENT_THROTTLE_cmdHandlerBase()

◆ CLEAR_EVENT_THROTTLE_preMsgHook()

◆ cmdIn_handlerBase()

◆ cmdResponse_out()

◆ deallocBufferSendOut_out()

◆ dpWrittenOut_out()

◆ get_bufferSendIn_InputPort()

◆ get_cmdIn_InputPort()

◆ get_schedIn_InputPort()

◆ getNum_bufferSendIn_InputPorts()

◆ getNum_cmdIn_InputPorts()

◆ getNum_cmdRegIn_OutputPorts()

◆ getNum_cmdResponseOut_OutputPorts()

◆ getNum_deallocBufferSendOut_OutputPorts()

◆ getNum_dpWrittenOut_OutputPorts()

◆ getNum_eventOut_OutputPorts()

◆ getNum_procBufferSendOut_OutputPorts()

◆ getNum_schedIn_InputPorts()

◆ getNum_timeGetOut_OutputPorts()

◆ getNum_tlmOut_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_cmdRegIn_OutputPort()

◆ isConnected_cmdResponseOut_OutputPort()

◆ isConnected_deallocBufferSendOut_OutputPort()

◆ isConnected_dpWrittenOut_OutputPort()

◆ isConnected_eventOut_OutputPort()

◆ isConnected_procBufferSendOut_OutputPort()

◆ isConnected_timeGetOut_OutputPort()

◆ isConnected_tlmOut_OutputPort()

◆ log_ACTIVITY_LO_FileWritten()

◆ log_WARNING_HI_BufferTooSmallForData()

◆ log_WARNING_HI_BufferTooSmallForData_ThrottleClear()

◆ log_WARNING_HI_BufferTooSmallForPacket()

◆ log_WARNING_HI_BufferTooSmallForPacket_ThrottleClear()

◆ log_WARNING_HI_FileOpenError()

◆ log_WARNING_HI_FileOpenError_ThrottleClear()

◆ log_WARNING_HI_FileWriteError()

◆ log_WARNING_HI_FileWriteError_ThrottleClear()

◆ log_WARNING_HI_InvalidBuffer()

◆ log_WARNING_HI_InvalidBuffer_ThrottleClear()

◆ log_WARNING_HI_InvalidHeader()

◆ log_WARNING_HI_InvalidHeader_ThrottleClear()

◆ log_WARNING_HI_InvalidHeaderHash()

◆ log_WARNING_HI_InvalidHeaderHash_ThrottleClear()

◆ procBufferSendOut_out()

◆ regCommands()

◆ schedIn_handler()

◆ schedIn_handlerBase()

◆ schedIn_preMsgHook()

◆ set_cmdRegIn_OutputPort()

◆ set_cmdResponseOut_OutputPort()

◆ set_deallocBufferSendOut_OutputPort()

◆ set_dpWrittenOut_OutputPort()

◆ set_eventOut_OutputPort()

◆ set_procBufferSendOut_OutputPort()