7 #ifndef Svc_DpWriterComponentAc_HPP 8 #define Svc_DpWriterComponentAc_HPP 22 #if !FW_DIRECT_PORT_CALLS 25 #if !FW_DIRECT_PORT_CALLS 138 #if !FW_DIRECT_PORT_CALLS 155 #if !FW_DIRECT_PORT_CALLS 179 #if !FW_DIRECT_PORT_CALLS 205 #if FW_ENABLE_TEXT_LOGGING == 1 208 void set_textEventOut_OutputPort(
229 #if !FW_DIRECT_PORT_CALLS 257 #if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION 268 Fw::InputSerializePort* port
274 Fw::InputSerializePort* port
280 Fw::InputSerializePort* port
283 #if FW_ENABLE_TEXT_LOGGING == 1 286 void set_textEventOut_OutputPort(
288 Fw::InputSerializePort* port
296 Fw::InputSerializePort* port
302 Fw::InputSerializePort* port
307 #if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION 318 Fw::InputSerializePort* port
324 Fw::InputSerializePort* port
330 Fw::InputSerializePort* port
354 const char* compName =
"" 420 #if FW_ENABLE_TEXT_LOGGING == 1 425 static constexpr
FwIndexType getNum_textEventOut_OutputPorts() {
499 #if FW_ENABLE_TEXT_LOGGING == 1 504 bool isConnected_textEventOut_OutputPort(
551 #if FW_DIRECT_PORT_CALLS 589 #if FW_DIRECT_PORT_CALLS 907 static void m_p_cmdIn_in(
922 static void m_p_bufferSendIn_in(
929 static void m_p_schedIn_in(
948 void cmdResponseOut_out(
964 #if FW_ENABLE_TEXT_LOGGING 967 void textEventOut_out(
991 #if !FW_DIRECT_PORT_CALLS 1004 #if !FW_DIRECT_PORT_CALLS 1020 #if !FW_DIRECT_PORT_CALLS 1037 #if FW_ENABLE_TEXT_LOGGING == 1 1052 #if !FW_DIRECT_PORT_CALLS 1078 std::atomic<FwIndexType> m_InvalidBufferThrottle;
1081 std::atomic<FwIndexType> m_BufferTooSmallForPacketThrottle;
1084 std::atomic<FwIndexType> m_InvalidHeaderHashThrottle;
1087 std::atomic<FwIndexType> m_InvalidHeaderThrottle;
1090 std::atomic<FwIndexType> m_BufferTooSmallForDataThrottle;
1093 std::atomic<FwIndexType> m_FileOpenErrorThrottle;
1096 std::atomic<FwIndexType> m_FileWriteErrorThrottle;
1105 bool m_first_update_NumBuffersReceived =
true;
1108 bool m_first_update_NumBytesWritten =
true;
1111 bool m_first_update_NumSuccessfulWrites =
true;
1114 bool m_first_update_NumFailedWrites =
true;
1117 bool m_first_update_NumErrors =
true;
1126 U32 m_last_NumBuffersReceived = {};
1129 U64 m_last_NumBytesWritten = {};
1132 U32 m_last_NumSuccessfulWrites = {};
1135 U32 m_last_NumFailedWrites = {};
1138 U32 m_last_NumErrors = {};
Throttle reset count for InvalidBuffer.
static constexpr FwIndexType getNum_bufferSendIn_InputPorts()
Throttle reset count for InvalidHeader.
virtual ~DpWriterComponentBase()
Destroy DpWriterComponentBase object.
bool isConnected_cmdResponseOut_OutputPort(FwIndexType portNum) const
Received buffer is too small to hold the data specified in the header.
FwIdType FwOpcodeType
The type of a command opcode.
void log_WARNING_HI_BufferTooSmallForData(FwSizeType bufferSize, U32 minSize)
void schedIn_handlerBase(FwIndexType portNum, U32 context)
Handler base-class function for input port schedIn.
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.
Received buffer is too small to hold a data product packet.
static constexpr FwIndexType getNum_eventOut_OutputPorts()
void set_dpWrittenOut_OutputPort(FwIndexType portNum, Svc::InputDpWrittenPort *port)
Connect port to dpWrittenOut[portNum].
Channel ID for NumSuccessfulWrites.
void cmdResponse_out(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
Emit command response.
friend class DpWriterTester
Friend class tester implementation to support white-box testing.
Throttle reset count for BufferTooSmallForData.
Channel ID for NumBytesWritten.
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()
An error occurred when writing to a file.
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.
Throttle reset count for InvalidHeaderHash.
The received buffer has an invalid header hash.
static constexpr FwIndexType getNum_deallocBufferSendOut_OutputPorts()
void tlmWrite_NumErrors(U32 arg, Fw::Time _tlmTime=Fw::Time())
void init()
Object initializer.
bool isConnected_dpWrittenOut_OutputPort(FwIndexType portNum) const
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.
Throttle reset count for FileWriteError.
void CLEAR_EVENT_THROTTLE_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
Throttle reset count for FileOpenError.
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.
Error occurred when deserializing the packet header.
Fw::InputCmdPort * get_cmdIn_InputPort(FwIndexType portNum)
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.
void log_WARNING_HI_FileOpenError_ThrottleClear()
Reset throttle value for FileOpenError.
static constexpr FwIndexType getNum_tlmOut_OutputPorts()
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_InvalidHeaderHash_ThrottleClear()
Reset throttle value for InvalidHeaderHash.
bool isConnected_procBufferSendOut_OutputPort(FwIndexType portNum) const
void log_WARNING_HI_BufferTooSmallForPacket(FwSizeType bufferSize, U32 minSize)
void regCommands()
Register commands with the Command Dispatcher.
Channel ID for NumErrors.
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()
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())
Throttle reset count for BufferTooSmallForPacket.
An error occurred when opening a file.
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].
Channel ID for NumFailedWrites.
void log_WARNING_HI_InvalidBuffer()
Channel ID for NumBuffersReceived.
Received buffer is invalid.
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.
static constexpr FwIndexType getNum_cmdIn_InputPorts()