#include <Svc/DpCatalog/DpCatalog.hpp>

Inheritance diagram for Svc::DpCatalog:

Public Member Functions
	DpCatalog (const char *const compName)
	DpCatalog constructor.

	~DpCatalog ()
	DpCatalog destructor.

void	configure (Fw::FileNameString directories[DP_MAX_DIRECTORIES], FwSizeType numDirs, Fw::FileNameString &stateFile, NATIVE_UINT_TYPE memId, Fw::MemAllocator &allocator)
	Configure the DpCatalog.

void	shutdown ()

Public Member Functions inherited from Svc::DpCatalogComponentBase
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize DpCatalogComponentBase object.

Fw::InputCmdPort *	get_CmdDisp_InputPort (FwIndexType portNum)

Svc::InputSendFileCompletePort *	get_fileDone_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)

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

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

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

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

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

void	set_fileOut_OutputPort (FwIndexType portNum, Svc::InputSendFileRequestPort *port)
	Connect port to fileOut[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

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 Types inherited from Svc::DpCatalogComponentBase
enum	{ NUM_CMDDISP_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...

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

enum	{ NUM_CMDREG_OUTPUT_PORTS = 1 , NUM_CMDSTATUS_OUTPUT_PORTS = 1 , NUM_LOG_OUTPUT_PORTS = 1 , NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_TIME_OUTPUT_PORTS = 1 , NUM_TLM_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

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

enum	{ OPCODE_BUILD_CATALOG = 0x0 , OPCODE_START_XMIT_CATALOG = 0x1 , OPCODE_STOP_XMIT_CATALOG = 0x2 , OPCODE_CLEAR_CATALOG = 0x3 }
	Command opcodes. More...

enum	{ EVENTID_DIRECTORYOPENERROR = 0x0 , EVENTID_PROCESSINGDIRECTORY = 0x1 , EVENTID_PROCESSINGFILE = 0x2 , EVENTID_PROCESSINGDIRECTORYCOMPLETE = 0x3 , EVENTID_CATALOGBUILDCOMPLETE = 0x4 , EVENTID_CATALOGXMITSTARTED = 0xa , EVENTID_CATALOGXMITSTOPPED = 0xb , EVENTID_CATALOGXMITCOMPLETED = 0xc , EVENTID_SENDINGPRODUCT = 0xd , EVENTID_PRODUCTCOMPLETE = 0xe , EVENTID_COMPONENTNOTINITIALIZED = 0x14 , EVENTID_COMPONENTNOMEMORY = 0x15 , EVENTID_CATALOGFULL = 0x16 , EVENTID_FILEOPENERROR = 0x17 , EVENTID_FILEREADERROR = 0x18 , EVENTID_FILEHDRERROR = 0x19 , EVENTID_FILEHDRDESERROR = 0x1a , EVENTID_DPINSERTERROR = 0x1b , EVENTID_DPDUPLICATE = 0x1c , EVENTID_DPCATALOGFULL = 0x1d , EVENTID_DPXMITINPROGRESS = 0x1e , EVENTID_FILESIZEERROR = 0x1f , EVENTID_NODPMEMORY = 0x20 , EVENTID_NOTINITIALIZED = 0x21 , EVENTID_XMITNOTACTIVE = 0x22 , EVENTID_STATEFILEOPENERROR = 0x23 , EVENTID_STATEFILEREADERROR = 0x24 , EVENTID_STATEFILETRUNCATED = 0x25 , EVENTID_NOSTATEFILESPECIFIED = 0x26 , EVENTID_STATEFILEWRITEERROR = 0x27 , EVENTID_NOSTATEFILE = 0x28 , EVENTID_STATEFILEXMITERROR = 0x29 }
	Event IDs. More...

enum	{ EVENTID_COMPONENTNOTINITIALIZED_THROTTLE = 10 , EVENTID_COMPONENTNOMEMORY_THROTTLE = 10 , EVENTID_CATALOGFULL_THROTTLE = 10 , EVENTID_FILEOPENERROR_THROTTLE = 10 , EVENTID_FILEREADERROR_THROTTLE = 10 , EVENTID_FILEHDRERROR_THROTTLE = 10 , EVENTID_FILEHDRDESERROR_THROTTLE = 10 , EVENTID_DPINSERTERROR_THROTTLE = 10 , EVENTID_DPDUPLICATE_THROTTLE = 10 , EVENTID_DPCATALOGFULL_THROTTLE = 10 , EVENTID_DPXMITINPROGRESS_THROTTLE = 10 , EVENTID_FILESIZEERROR_THROTTLE = 10 }
	Event throttle values: sets initial value of countdown variables. More...

enum	{ CHANNELID_CATALOGDPS = 0x0 , CHANNELID_DPSSENT = 0x1 }
	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 inherited from Svc::DpCatalogComponentBase
	DpCatalogComponentBase (const char *compName="")
	Construct DpCatalogComponentBase object.

virtual	~DpCatalogComponentBase ()
	Destroy DpCatalogComponentBase object.

FwIndexType	getNum_CmdDisp_InputPorts () const

FwIndexType	getNum_fileDone_InputPorts () const

FwIndexType	getNum_pingIn_InputPorts () const

FwIndexType	getNum_CmdReg_OutputPorts () const

FwIndexType	getNum_CmdStatus_OutputPorts () const

FwIndexType	getNum_Log_OutputPorts () const

FwIndexType	getNum_Time_OutputPorts () const

FwIndexType	getNum_Tlm_OutputPorts () const

FwIndexType	getNum_fileOut_OutputPorts () const

FwIndexType	getNum_pingOut_OutputPorts () const

bool	isConnected_CmdReg_OutputPort (FwIndexType portNum)

bool	isConnected_CmdStatus_OutputPort (FwIndexType portNum)

bool	isConnected_Log_OutputPort (FwIndexType portNum)

bool	isConnected_Time_OutputPort (FwIndexType portNum)

bool	isConnected_Tlm_OutputPort (FwIndexType portNum)

bool	isConnected_fileOut_OutputPort (FwIndexType portNum)

bool	isConnected_pingOut_OutputPort (FwIndexType portNum)

void	fileDone_handlerBase (FwIndexType portNum, const Svc::SendFileResponse &resp)
	Handler base-class function for input port fileDone.

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

virtual void	fileDone_preMsgHook (FwIndexType portNum, const Svc::SendFileResponse &resp)
	Pre-message hook for async input port fileDone.

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

Svc::SendFileResponse	fileOut_out (FwIndexType portNum, const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName, U32 offset, U32 length)
	Invoke output port fileOut.

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

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

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

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

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

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

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

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

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

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

void	log_WARNING_HI_DirectoryOpenError (const Fw::StringBase &loc, I32 stat) const

void	log_ACTIVITY_LO_ProcessingDirectory (const Fw::StringBase &directory) const

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

void	log_ACTIVITY_HI_ProcessingDirectoryComplete (const Fw::StringBase &loc, U32 total, U32 pending, U64 pending_bytes) const

void	log_ACTIVITY_HI_CatalogBuildComplete () const

void	log_ACTIVITY_HI_CatalogXmitStarted () const

void	log_ACTIVITY_HI_CatalogXmitStopped (U32 bytes) const

void	log_ACTIVITY_HI_CatalogXmitCompleted (U64 bytes) const

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

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

void	log_WARNING_HI_ComponentNotInitialized ()

void	log_WARNING_HI_ComponentNoMemory ()

void	log_WARNING_HI_CatalogFull (const Fw::StringBase &dir)

void	log_WARNING_HI_FileOpenError (const Fw::StringBase &loc, I32 stat)

void	log_WARNING_HI_FileReadError (const Fw::StringBase &file, I32 stat)

void	log_WARNING_HI_FileHdrError (const Fw::StringBase &file, Svc::DpHdrField field, U32 exp, U32 act)

void	log_WARNING_HI_FileHdrDesError (const Fw::StringBase &file, I32 stat)

void	log_WARNING_HI_DpInsertError (Svc::DpRecord dp)

void	log_DIAGNOSTIC_DpDuplicate (Svc::DpRecord dp)

void	log_WARNING_HI_DpCatalogFull (Svc::DpRecord dp)

void	log_WARNING_LO_DpXmitInProgress ()

void	log_WARNING_HI_FileSizeError (const Fw::StringBase &file, I32 stat)

void	log_WARNING_HI_NoDpMemory () const
	Log event NoDpMemory.

void	log_WARNING_HI_NotInitialized () const
	Log event NotInitialized.

void	log_WARNING_LO_XmitNotActive () const
	Log event XmitNotActive.

void	log_WARNING_HI_StateFileOpenError (const Fw::StringBase &file, I32 stat) const
	Log event StateFileOpenError.

void	log_WARNING_HI_StateFileReadError (const Fw::StringBase &file, I32 stat, I32 offset) const
	Log event StateFileReadError.

void	log_WARNING_HI_StateFileTruncated (const Fw::StringBase &file, I32 offset, I32 size) const
	Log event StateFileTruncated.

void	log_WARNING_LO_NoStateFileSpecified () const
	Log event NoStateFileSpecified.

void	log_WARNING_HI_StateFileWriteError (const Fw::StringBase &file, I32 stat) const
	Log event StateFileWriteError.

void	log_WARNING_LO_NoStateFile (const Fw::StringBase &file) const
	Log event NoStateFile.

void	log_WARNING_HI_StateFileXmitError (const Fw::StringBase &file, Svc::SendFileStatus stat) const
	Log event StateFileXmitError.

void	log_WARNING_HI_ComponentNotInitialized_ThrottleClear ()
	Reset throttle value for ComponentNotInitialized.

void	log_WARNING_HI_ComponentNoMemory_ThrottleClear ()
	Reset throttle value for ComponentNoMemory.

void	log_WARNING_HI_CatalogFull_ThrottleClear ()
	Reset throttle value for CatalogFull.

void	log_WARNING_HI_FileOpenError_ThrottleClear ()
	Reset throttle value for FileOpenError.

void	log_WARNING_HI_FileReadError_ThrottleClear ()
	Reset throttle value for FileReadError.

void	log_WARNING_HI_FileHdrError_ThrottleClear ()
	Reset throttle value for FileHdrError.

void	log_WARNING_HI_FileHdrDesError_ThrottleClear ()
	Reset throttle value for FileHdrDesError.

void	log_WARNING_HI_DpInsertError_ThrottleClear ()
	Reset throttle value for DpInsertError.

void	log_DIAGNOSTIC_DpDuplicate_ThrottleClear ()
	Reset throttle value for DpDuplicate.

void	log_WARNING_HI_DpCatalogFull_ThrottleClear ()
	Reset throttle value for DpCatalogFull.

void	log_WARNING_LO_DpXmitInProgress_ThrottleClear ()
	Reset throttle value for DpXmitInProgress.

void	log_WARNING_HI_FileSizeError_ThrottleClear ()
	Reset throttle value for FileSizeError.

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

void	tlmWrite_DpsSent (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.

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

Definition at line 21 of file DpCatalog.hpp.

Constructor & Destructor Documentation

◆ DpCatalog()

Svc::DpCatalog::DpCatalog ( const char *const compName )

DpCatalog constructor.

Parameters

compName component name

Parameters

compName The component name

Definition at line 22 of file DpCatalog.cpp.

◆ ~DpCatalog()

Svc::DpCatalog::~DpCatalog ( )

DpCatalog destructor.

Definition at line 50 of file DpCatalog.cpp.

Member Function Documentation

◆ configure()

void Svc::DpCatalog::configure	(	Fw::FileNameString	directories[DP_MAX_DIRECTORIES],
		FwSizeType	numDirs,
		Fw::FileNameString &	stateFile,
		NATIVE_UINT_TYPE	memId,
		Fw::MemAllocator &	allocator
	)

Configure the DpCatalog.

Parameters

maxDpFiles	The max number of data product files to track
directories	list of directories to scan
numDirs	number of supplied directories
stateFile	file to store transmit state. Provide a zero-length string if no state tracking
memId	memory ID for allocator
allocator	Allocator to supply memory for catalog. Instance must survive for shutdown to use for reclaiming memory

Definition at line 54 of file DpCatalog.cpp.

◆ shutdown()

void Svc::DpCatalog::shutdown ( )

Definition at line 778 of file DpCatalog.cpp.

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

Svc/DpCatalog/DpCatalog.hpp
Svc/DpCatalog/DpCatalog.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DpCatalog()

◆ ~DpCatalog()

Member Function Documentation

◆ configure()

◆ shutdown()