Svc::DpCompressProc Class Reference

#include <Svc/DpCompressProc/DpCompressProc.hpp>

Inheritance diagram for Svc::DpCompressProc:

Public Member Functions
	DpCompressProc (const char *const compName)
	Construct DpCompressProc object. More...
	~DpCompressProc ()
	Destroy DpCompressProc object. More...
Public Member Functions inherited from Svc::DpCompressProcComponentBase
void	init (FwEnumStoreType instance=0)
	Initialize DpCompressProcComponentBase object. More...
Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)
Fw::InputBufferSendPort *	get_procRequest_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_dpGet_OutputPort (FwIndexType portNum, Fw::InputDpGetPort *port)
	Connect port to dpGet[portNum]. More...
void	set_dpSend_OutputPort (FwIndexType portNum, Fw::InputDpSendPort *port)
	Connect port to dpSend[portNum]. More...
void	set_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to logOut[portNum]. More...
void	set_prmGetOut_OutputPort (FwIndexType portNum, Fw::InputPrmGetPort *port)
	Connect port to prmGetOut[portNum]. More...
void	set_prmSetOut_OutputPort (FwIndexType portNum, Fw::InputPrmSetPort *port)
	Connect port to prmSetOut[portNum]. More...
void	set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum]. More...
void	set_compressChunk_OutputPort (FwIndexType portNum, Svc::InputCompressChunkPort *port)
	Connect port to compressChunk[portNum]. More...
void	regCommands ()
	Register commands with the Command Dispatcher. More...
void	loadParameters ()
	Load the parameters from a parameter source. More...
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const FwIdType)
	Set the ID base. More...
FwIdType	getIdBase () const
virtual void	deinit ()
	Deinitialization function. More...

Additional Inherited Members
Protected Types inherited from Svc::DpCompressProcComponentBase
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...
enum	{ NUM_PROCREQUEST_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...
enum	{   NUM_CMDREGOUT_OUTPUT_PORTS = 1, NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1, NUM_DPGET_OUTPUT_PORTS = 1, NUM_DPSEND_OUTPUT_PORTS = 1,   NUM_LOGOUT_OUTPUT_PORTS = 1, NUM_LOGTEXTOUT_OUTPUT_PORTS = 1, NUM_PRMGETOUT_OUTPUT_PORTS = 1, NUM_PRMSETOUT_OUTPUT_PORTS = 1,   NUM_TIMECALLER_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...
enum	{ NUM_COMPRESSCHUNK_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...
enum	{ OPCODE_CHUNK_SIZE_SET = 0x0, OPCODE_CHUNK_SIZE_SAVE = 0x1, OPCODE_ENABLE_SET = 0x2, OPCODE_ENABLE_SAVE = 0x3 }
	Command opcodes. More...
enum	{   EVENTID_COMPRESSIONCOMPLETE = 0x0, EVENTID_DIDNOTCOMPRESS = 0x1, EVENTID_INVALIDHEADER = 0x2, EVENTID_BUFFERTOOSMALLFORPACKET = 0x3,   EVENTID_CONTAINERTOOLARGE = 0x4 }
	Event IDs. More...
enum	{ EVENTID_DIDNOTCOMPRESS_THROTTLE = 10, EVENTID_INVALIDHEADER_THROTTLE = 10, EVENTID_BUFFERTOOSMALLFORPACKET_THROTTLE = 10, EVENTID_CONTAINERTOOLARGE_THROTTLE = 10 }
	Event throttle values: sets initial value of countdown variables. More...
enum	{ PARAMID_CHUNK_SIZE = 0x0, PARAMID_ENABLE = 0x1 }
	Parameter IDs. More...
Protected Member Functions inherited from Svc::DpCompressProcComponentBase
	DpCompressProcComponentBase (const char *compName="")
	Construct DpCompressProcComponentBase object. More...
virtual	~DpCompressProcComponentBase ()
	Destroy DpCompressProcComponentBase object. More...
bool	isConnected_cmdRegOut_OutputPort (FwIndexType portNum) const
bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) const
bool	isConnected_dpGet_OutputPort (FwIndexType portNum) const
bool	isConnected_dpSend_OutputPort (FwIndexType portNum) const
bool	isConnected_logOut_OutputPort (FwIndexType portNum) const
bool	isConnected_prmGetOut_OutputPort (FwIndexType portNum) const
bool	isConnected_prmSetOut_OutputPort (FwIndexType portNum) const
bool	isConnected_timeCaller_OutputPort (FwIndexType portNum) const
bool	isConnected_compressChunk_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...
void	procRequest_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port procRequest. More...
Svc::CompressionAlgorithm	compressChunk_out (FwIndexType portNum, Fw::Buffer &buffer, FwSizeType min_compression, FwSizeType write_offset) const
	Invoke output port compressChunk. More...
void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...
void	log_DIAGNOSTIC_CompressionComplete (FwDpIdType dp_id, FwSizeType initial_size, FwSizeType final_size) const
	Log event CompressionComplete. More...
void	log_ACTIVITY_LO_DidNotCompress (FwDpIdType dp_id, FwSizeType data_size)
	Log event DidNotCompress. More...
void	log_WARNING_HI_InvalidHeader (FwSizeType buffer_size, U32 error_code)
void	log_WARNING_HI_BufferTooSmallForPacket (FwSizeType buffer_size, FwSizeType min_size)
void	log_WARNING_HI_ContainerTooLarge (FwDpIdType dp_id, FwSizeType data_size)
void	log_ACTIVITY_LO_DidNotCompress_ThrottleClear ()
	Reset throttle value for DidNotCompress. More...
void	log_WARNING_HI_InvalidHeader_ThrottleClear ()
	Reset throttle value for InvalidHeader. More...
void	log_WARNING_HI_BufferTooSmallForPacket_ThrottleClear ()
	Reset throttle value for BufferTooSmallForPacket. More...
void	log_WARNING_HI_ContainerTooLarge_ThrottleClear ()
	Reset throttle value for ContainerTooLarge. More...
virtual void	parameterUpdated (FwPrmIdType id)
	Called whenever a parameter is updated. More...
virtual void	parametersLoaded ()
	Called whenever parameters are loaded. More...
FwSizeStoreType	paramGet_CHUNK_SIZE (Fw::ParamValid &valid)
Fw::Enabled	paramGet_ENABLE (Fw::ParamValid &valid)
Fw::Success::T	dpGet_Dummy (FwSizeType dataSize, DpContainer &container)
void	dpSend (DpContainer &container, Fw::Time timeTag=Fw::ZERO_TIME)
	Send a data product. More...
Fw::Time	getTime () const
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 inherited from Svc::DpCompressProcComponentBase
static constexpr FwSizeType	SIZE_OF_CompressionRecord_RECORD (FwSizeType arraySize)
	Record sizes. More...
static constexpr FwIndexType	getNum_cmdIn_InputPorts ()
static constexpr FwIndexType	getNum_procRequest_InputPorts ()
static constexpr FwIndexType	getNum_cmdRegOut_OutputPorts ()
static constexpr FwIndexType	getNum_cmdResponseOut_OutputPorts ()
static constexpr FwIndexType	getNum_dpGet_OutputPorts ()
static constexpr FwIndexType	getNum_dpSend_OutputPorts ()
static constexpr FwIndexType	getNum_logOut_OutputPorts ()
static constexpr FwIndexType	getNum_prmGetOut_OutputPorts ()
static constexpr FwIndexType	getNum_prmSetOut_OutputPorts ()
static constexpr FwIndexType	getNum_timeCaller_OutputPorts ()
static constexpr FwIndexType	getNum_compressChunk_OutputPorts ()

Detailed Description

Definition at line 15 of file DpCompressProc.hpp.

Constructor & Destructor Documentation

DpCompressProc()

Svc::DpCompressProc::DpCompressProc

(

const char *const

compName

)

Construct DpCompressProc object.

Parameters

compName

The component name

Definition at line 20 of file DpCompressProc.cpp.

~DpCompressProc()

Svc::DpCompressProc::~DpCompressProc

(

)

Destroy DpCompressProc object.

Definition at line 22 of file DpCompressProc.cpp.

---

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

• Svc/DpCompressProc/DpCompressProc.hpp
• Svc/DpCompressProc/DpCompressProc.cpp