7 #ifndef Svc_DpWriterComponentAc_HPP 8 #define Svc_DpWriterComponentAc_HPP 22 #if !FW_DIRECT_PORT_CALLS 25 #if !FW_DIRECT_PORT_CALLS 141 #if !FW_DIRECT_PORT_CALLS 158 #if !FW_DIRECT_PORT_CALLS 182 #if !FW_DIRECT_PORT_CALLS 208 #if FW_ENABLE_TEXT_LOGGING == 1 211 void set_textEventOut_OutputPort(
232 #if !FW_DIRECT_PORT_CALLS 260 #if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION 271 Fw::InputSerializePort* port
277 Fw::InputSerializePort* port
283 Fw::InputSerializePort* port
286 #if FW_ENABLE_TEXT_LOGGING == 1 289 void set_textEventOut_OutputPort(
291 Fw::InputSerializePort* port
299 Fw::InputSerializePort* port
305 Fw::InputSerializePort* port
310 #if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION 321 Fw::InputSerializePort* port
327 Fw::InputSerializePort* port
333 Fw::InputSerializePort* port
357 const char* compName =
"" 423 #if FW_ENABLE_TEXT_LOGGING == 1 428 static constexpr
FwIndexType getNum_textEventOut_OutputPorts() {
502 #if FW_ENABLE_TEXT_LOGGING == 1 507 bool isConnected_textEventOut_OutputPort(
554 #if FW_DIRECT_PORT_CALLS 592 #if FW_DIRECT_PORT_CALLS 920 static void m_p_cmdIn_in(
935 static void m_p_bufferSendIn_in(
942 static void m_p_schedIn_in(
961 void cmdResponseOut_out(
977 #if FW_ENABLE_TEXT_LOGGING 980 void textEventOut_out(
1004 #if !FW_DIRECT_PORT_CALLS 1017 #if !FW_DIRECT_PORT_CALLS 1033 #if !FW_DIRECT_PORT_CALLS 1050 #if FW_ENABLE_TEXT_LOGGING == 1 1065 #if !FW_DIRECT_PORT_CALLS 1091 std::atomic<FwIndexType> m_InvalidBufferThrottle;
1094 std::atomic<FwIndexType> m_BufferTooSmallForPacketThrottle;
1097 std::atomic<FwIndexType> m_InvalidHeaderHashThrottle;
1100 std::atomic<FwIndexType> m_InvalidHeaderThrottle;
1103 std::atomic<FwIndexType> m_BufferTooSmallForDataThrottle;
1106 std::atomic<FwIndexType> m_FileNameFormatErrorThrottle;
1109 std::atomic<FwIndexType> m_FileOpenErrorThrottle;
1112 std::atomic<FwIndexType> m_FileWriteErrorThrottle;
1121 bool m_first_update_NumBuffersReceived =
true;
1124 bool m_first_update_NumBytesWritten =
true;
1127 bool m_first_update_NumSuccessfulWrites =
true;
1130 bool m_first_update_NumFailedWrites =
true;
1133 bool m_first_update_NumErrors =
true;
1142 U32 m_last_NumBuffersReceived = {};
1145 U64 m_last_NumBytesWritten = {};
1148 U32 m_last_NumSuccessfulWrites = {};
1151 U32 m_last_NumFailedWrites = {};
1154 U32 m_last_NumErrors = {};
static constexpr FwIndexType getNum_bufferSendIn_InputPorts()
virtual ~DpWriterComponentBase()
Destroy DpWriterComponentBase object.
An error occurred when formatting a file name.
bool isConnected_cmdResponseOut_OutputPort(FwIndexType portNum) const
Throttle reset count for BufferTooSmallForPacket.
FwIdType FwOpcodeType
The type of a command opcode.
void log_WARNING_HI_BufferTooSmallForData(FwSizeType bufferSize, U32 minSize)
Channel ID for NumSuccessfulWrites.
Throttle reset count for FileOpenError.
void schedIn_handlerBase(FwIndexType portNum, U32 context)
Handler base-class function for input port schedIn.
Channel ID for NumErrors.
virtual void CLEAR_EVENT_THROTTLE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq)=0
PlatformSizeType FwSizeType
static constexpr FwIndexType getNum_cmdResponseOut_OutputPorts()
bool isConnected_cmdRegIn_OutputPort(FwIndexType portNum) const
U32 FwDpPriorityType
The type of a data product priority.
static constexpr FwIndexType getNum_eventOut_OutputPorts()
Channel ID for NumFailedWrites.
void set_dpWrittenOut_OutputPort(FwIndexType portNum, Svc::InputDpWrittenPort *port)
Connect port to dpWrittenOut[portNum].
void cmdResponse_out(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
Emit command response.
void log_WARNING_HI_FileNameFormatError_ThrottleClear()
Reset throttle value for FileNameFormatError.
An error occurred when opening a file.
friend class DpWriterTester
Friend class tester implementation to support white-box testing.
bool isConnected_timeGetOut_OutputPort(FwIndexType portNum) const
Enum representing a command response.
virtual void bufferSendIn_preMsgHook(FwIndexType portNum, Fw::Buffer &fwBuffer)
Pre-message hook for async input port bufferSendIn.
static constexpr FwIndexType getNum_schedIn_InputPorts()
Throttle reset count for BufferTooSmallForData.
static constexpr FwIndexType getNum_timeGetOut_OutputPorts()
void cmdIn_handlerBase(FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
Handler base-class function for input port cmdIn.
static constexpr FwIndexType getNum_deallocBufferSendOut_OutputPorts()
Received buffer is too small to hold a data product packet.
An error occurred when writing to a file.
void tlmWrite_NumErrors(U32 arg, Fw::Time _tlmTime=Fw::Time())
void init()
Object initializer.
bool isConnected_dpWrittenOut_OutputPort(FwIndexType portNum) const
Throttle reset count for InvalidHeaderHash.
Fw::InputBufferSendPort * get_bufferSendIn_InputPort(FwIndexType portNum)
bool isConnected_deallocBufferSendOut_OutputPort(FwIndexType portNum) const
void deallocBufferSendOut_out(FwIndexType portNum, Fw::Buffer &fwBuffer) const
Invoke output port deallocBufferSendOut.
void log_WARNING_HI_InvalidBuffer_ThrottleClear()
Reset throttle value for InvalidBuffer.
FwIdType FwEventIdType
The type of an event identifier.
void tlmWrite_NumFailedWrites(U32 arg, Fw::Time _tlmTime=Fw::Time())
void log_WARNING_HI_FileWriteError_ThrottleClear()
Reset throttle value for FileWriteError.
void CLEAR_EVENT_THROTTLE_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void tlmWrite(FwChanIdType id, Fw::TlmBuffer &_tlmBuff, Fw::Time _tlmTime=Fw::Time()) const
void dpWrittenOut_out(FwIndexType portNum, const Fw::StringBase &fileName, FwDpPriorityType priority, FwSizeType size) const
Invoke output port dpWrittenOut.
Fw::InputCmdPort * get_cmdIn_InputPort(FwIndexType portNum)
Received buffer is too small to hold the data specified in the header.
void log_WARNING_HI_InvalidHeaderHash(FwSizeType bufferSize, U32 storedHash, U32 computedHash)
void set_deallocBufferSendOut_OutputPort(FwIndexType portNum, Fw::InputBufferSendPort *port)
Connect port to deallocBufferSendOut[portNum].
FwIdType FwChanIdType
The type of a telemetry channel identifier.
void tlmWrite_NumBuffersReceived(U32 arg, Fw::Time _tlmTime=Fw::Time())
static constexpr FwIndexType getNum_procBufferSendOut_OutputPorts()
void procBufferSendOut_out(FwIndexType portNum, Fw::Buffer &fwBuffer) const
Invoke output port procBufferSendOut.
void log_WARNING_HI_BufferTooSmallForData_ThrottleClear()
Reset throttle value for BufferTooSmallForData.
Received buffer is invalid.
void log_WARNING_HI_FileOpenError_ThrottleClear()
Reset throttle value for FileOpenError.
static constexpr FwIndexType getNum_tlmOut_OutputPorts()
Channel ID for NumBytesWritten.
DpWriterComponentBase(const char *compName="")
Construct DpWriterComponentBase object.
void log_WARNING_HI_FileOpenError(U32 status, const Fw::StringBase &file)
void log_WARNING_HI_InvalidHeader_ThrottleClear()
Reset throttle value for InvalidHeader.
Enum representing event severity.
void log_WARNING_HI_FileNameFormatError(const Fw::StringFormatStatus &status)
void log_WARNING_HI_InvalidHeaderHash_ThrottleClear()
Reset throttle value for InvalidHeaderHash.
bool isConnected_procBufferSendOut_OutputPort(FwIndexType portNum) const
void log_WARNING_HI_BufferTooSmallForPacket(FwSizeType bufferSize, U32 minSize)
The received buffer has an invalid header hash.
void regCommands()
Register commands with the Command Dispatcher.
void set_tlmOut_OutputPort(FwIndexType portNum, Fw::InputTlmPort *port)
Connect port to tlmOut[portNum].
bool isConnected_eventOut_OutputPort(FwIndexType portNum) const
void set_cmdResponseOut_OutputPort(FwIndexType portNum, Fw::InputCmdResponsePort *port)
Connect port to cmdResponseOut[portNum].
void log_ACTIVITY_LO_FileWritten(U32 bytes, const Fw::StringBase &file) const
static constexpr FwIndexType getNum_cmdRegIn_OutputPorts()
Throttle reset count for InvalidBuffer.
Channel ID for NumBuffersReceived.
Throttle reset count for FileWriteError.
virtual void CLEAR_EVENT_THROTTLE_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
Pre-message hook for command CLEAR_EVENT_THROTTLE.
virtual void schedIn_handler(FwIndexType portNum, U32 context)=0
Handler for input port schedIn.
PlatformIndexType FwIndexType
static constexpr FwIndexType getNum_dpWrittenOut_OutputPorts()
void set_eventOut_OutputPort(FwIndexType portNum, Fw::InputLogPort *port)
Connect port to eventOut[portNum].
bool isConnected_tlmOut_OutputPort(FwIndexType portNum) const
virtual void bufferSendIn_handler(FwIndexType portNum, Fw::Buffer &fwBuffer)=0
Handler for input port bufferSendIn.
void log_WARNING_HI_FileWriteError(U32 status, U32 bytesWritten, U32 bytesToWrite, const Fw::StringBase &file)
void set_timeGetOut_OutputPort(FwIndexType portNum, Fw::InputTimePort *port)
Connect port to timeGetOut[portNum].
RateGroupDivider component implementation.
friend class DpWriterTesterBase
Friend class tester to support autocoded test harness.
void bufferSendIn_handlerBase(FwIndexType portNum, Fw::Buffer &fwBuffer)
Handler base-class function for input port bufferSendIn.
void tlmWrite_NumBytesWritten(U64 arg, Fw::Time _tlmTime=Fw::Time())
virtual void schedIn_preMsgHook(FwIndexType portNum, U32 context)
Pre-message hook for async input port schedIn.
void log_WARNING_HI_InvalidHeader(FwSizeType bufferSize, U32 errorCode)
void tlmWrite_NumSuccessfulWrites(U32 arg, Fw::Time _tlmTime=Fw::Time())
void log_WARNING_HI_BufferTooSmallForPacket_ThrottleClear()
Reset throttle value for BufferTooSmallForPacket.
void set_procBufferSendOut_OutputPort(FwIndexType portNum, Fw::InputBufferSendPort *port)
Connect port to procBufferSendOut[portNum].
void log_WARNING_HI_InvalidBuffer()
Throttle reset count for InvalidHeader.
Svc::InputSchedPort * get_schedIn_InputPort(FwIndexType portNum)
void set_cmdRegIn_OutputPort(FwIndexType portNum, Fw::InputCmdRegPort *port)
Connect port to cmdRegIn[portNum].
Auto-generated base for DpWriter component.
Error occurred when deserializing the packet header.
static constexpr FwIndexType getNum_cmdIn_InputPorts()
Throttle reset count for FileNameFormatError.