Vince Woo 48e4720419
Created new SerialBufferBase as a parent of SerializeBufferBase (now renamed LinearBufferBase). (#4288)
* Created new SerialBufferBase as a parent of SerializeBufferBase. Renaming interface functions to be less confusing.

* Deprecating copyRawOffset. No direct use-cases in F' core.

* Make SerialBufferBase a true pure virtual interface.

* Changing Serializable to work with SerialBufferBase parent interface.

* Changing copyRaw and copyRawOffset to work with SerialBufferBase

* Updating documentation for SerialBufferBase usage

* Adding some documentation. Adding missing ASSERT in copyRaw. Fixing some bugs that new ASSERT uncovered.

* Renaming SerializeBufferBase to LinearBufferBase. Add a using declaration to maintain backwards compatability. Properly mark LinearBufferBase functions as override.

* Filling in the rest of the docstrings for the classes in Serializable

* Removing redundant virtual keyword on override function

* Applying clang formatting

* Incorporating PR comments

* Fix compile issues

* Bump version to alpha

* Format

* v

---------

Co-authored-by: M Starch <LeStarch@googlemail.com>
2025-11-06 16:23:20 -08:00

228 lines
9.5 KiB
C++

// ======================================================================
// \title ActiveTest.cpp
// \author tiffany
// \brief cpp file for ActiveTest component implementation class
// ======================================================================
#include "ActiveTest.hpp"
#include <Fw/FPrimeBasicTypes.hpp>
#include "FppTest/component/active/SerialPortIndexEnumAc.hpp"
// ----------------------------------------------------------------------
// Construction, initialization, and destruction
// ----------------------------------------------------------------------
ActiveTest ::ActiveTest(const char* const compName) : ActiveTestComponentBase(compName) {}
ActiveTest ::~ActiveTest() {}
#define TestComponentName ActiveTest
#include "FppTest/component/common/typed.cpp"
#include "FppTest/component/common/typed_async.cpp"
// ----------------------------------------------------------------------
// Handler implementations for user-defined serial input ports
// ----------------------------------------------------------------------
void ActiveTest ::serialAsync_handler(FwIndexType portNum, //!< The port number
Fw::LinearBufferBase& Buffer //!< The serialization buffer
) {
this->serializeStatus = this->serialOut_out(portNum, Buffer);
}
void ActiveTest ::serialAsyncAssert_handler(FwIndexType portNum, //!< The port number
Fw::LinearBufferBase& Buffer //!< The serialization buffer
) {
this->serializeStatus = this->serialOut_out(SerialPortIndex::ENUM, Buffer);
}
void ActiveTest ::serialAsyncBlockPriority_handler(FwIndexType portNum, //!< The port number
Fw::LinearBufferBase& Buffer //!< The serialization buffer
) {
this->serializeStatus = this->serialOut_out(SerialPortIndex::ARRAY, Buffer);
}
void ActiveTest ::serialAsyncDropPriority_handler(FwIndexType portNum, //!< The port number
Fw::LinearBufferBase& Buffer //!< The serialization buffer
) {
this->serializeStatus = this->serialOut_out(SerialPortIndex::STRUCT, Buffer);
}
void ActiveTest ::serialGuarded_handler(FwIndexType portNum, //!< The port number
Fw::LinearBufferBase& Buffer //!< The serialization buffer
) {
this->serializeStatus = this->serialOut_out(portNum, Buffer);
}
void ActiveTest ::serialSync_handler(FwIndexType portNum, //!< The port number
Fw::LinearBufferBase& Buffer //!< The serialization buffer
) {
this->serializeStatus = this->serialOut_out(portNum, Buffer);
}
// ----------------------------------------------------------------------
// Command handler implementations
// ----------------------------------------------------------------------
void ActiveTest ::CMD_ASYNC_NO_ARGS_cmdHandler(const FwOpcodeType opCode, const U32 cmdSeq) {
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_ASYNC_PRIMITIVE_cmdHandler(const FwOpcodeType opCode,
const U32 cmdSeq,
U32 u32_1,
U32 u32_2,
F32 f32_1,
F32 f32_2,
bool b1,
bool b2) {
this->primitiveCmd.args.val1 = u32_1;
this->primitiveCmd.args.val2 = u32_2;
this->primitiveCmd.args.val3 = f32_1;
this->primitiveCmd.args.val4 = f32_2;
this->primitiveCmd.args.val5 = b1;
this->primitiveCmd.args.val6 = b2;
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_ASYNC_STRINGS_cmdHandler(const FwOpcodeType opCode,
const U32 cmdSeq,
const Fw::CmdStringArg& str1,
const Fw::CmdStringArg& str2) {
this->stringCmd.args.val1 = str1;
this->stringCmd.args.val2 = str2;
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_ASYNC_ENUM_cmdHandler(const FwOpcodeType opCode, const U32 cmdSeq, FormalParamEnum en) {
this->enumCmd.args.val = en;
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_ASYNC_ARRAY_cmdHandler(const FwOpcodeType opCode, const U32 cmdSeq, FormalParamArray arr) {
this->arrayCmd.args.val = arr;
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_ASYNC_STRUCT_cmdHandler(const FwOpcodeType opCode, const U32 cmdSeq, FormalParamStruct str) {
this->structCmd.args.val = str;
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_NO_ARGS_cmdHandler(const FwOpcodeType opCode, const U32 cmdSeq) {
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_PRIMITIVE_cmdHandler(const FwOpcodeType opCode,
const U32 cmdSeq,
U32 u32_1,
U32 u32_2,
F32 f32_1,
F32 f32_2,
bool b1,
bool b2) {
this->primitiveCmd.args.val1 = u32_1;
this->primitiveCmd.args.val2 = u32_2;
this->primitiveCmd.args.val3 = f32_1;
this->primitiveCmd.args.val4 = f32_2;
this->primitiveCmd.args.val5 = b1;
this->primitiveCmd.args.val6 = b2;
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_STRINGS_cmdHandler(const FwOpcodeType opCode,
const U32 cmdSeq,
const Fw::CmdStringArg& str1,
const Fw::CmdStringArg& str2) {
this->stringCmd.args.val1 = str1;
this->stringCmd.args.val2 = str2;
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_ENUM_cmdHandler(const FwOpcodeType opCode, const U32 cmdSeq, FormalParamEnum en) {
this->enumCmd.args.val = en;
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_ARRAY_cmdHandler(const FwOpcodeType opCode, const U32 cmdSeq, FormalParamArray arr) {
this->arrayCmd.args.val = arr;
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
void ActiveTest ::CMD_STRUCT_cmdHandler(const FwOpcodeType opCode, const U32 cmdSeq, FormalParamStruct str) {
this->structCmd.args.val = str;
this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}
// ----------------------------------------------------------------------
// Internal interface handlers
// ----------------------------------------------------------------------
//! Internal interface handler for internalArray
void ActiveTest ::internalArray_internalInterfaceHandler(const FormalParamArray& arr //!< An array
) {
this->arrayInterface.args.val = arr;
}
//! Internal interface handler for internalEnum
void ActiveTest ::internalEnum_internalInterfaceHandler(const FormalParamEnum& en //!< An enum
) {
this->enumInterface.args.val = en;
}
//! Internal interface handler for internalNoArgs
void ActiveTest ::internalNoArgs_internalInterfaceHandler() {}
//! Internal interface handler for internalPrimitive
void ActiveTest ::internalPrimitive_internalInterfaceHandler(U32 u32_1, //!< A U32
U32 u32_2, //!< A U32
F32 f32_1, //!< An F32
F32 f32_2, //!< An F32
bool b1, //!< A boolean
bool b2 //!< A boolean
) {
this->primitiveInterface.args.val1 = u32_1;
this->primitiveInterface.args.val2 = u32_2;
this->primitiveInterface.args.val3 = f32_1;
this->primitiveInterface.args.val4 = f32_2;
this->primitiveInterface.args.val5 = b1;
this->primitiveInterface.args.val6 = b2;
}
//! Internal interface handler for internalString
void ActiveTest ::internalString_internalInterfaceHandler(const Fw::InternalInterfaceString& str1, //!< A string
const Fw::InternalInterfaceString& str2 //!< Another string
) {
this->stringInterface.args.val1 = str1;
this->stringInterface.args.val2 = str2;
}
//! Internal interface handler for internalStruct
void ActiveTest ::internalStruct_internalInterfaceHandler(const FormalParamStruct& str //!< A struct
) {
this->structInterface.args.val = str;
}
// ----------------------------------------------------------------------
// Overflow hook implementations for user-defined async ports interfaces
// ----------------------------------------------------------------------
void ActiveTest ::enumArgsHook_overflowHook(const FwIndexType portNum,
const FormalParamEnum& en,
FormalParamEnum& enRef,
const FormalAliasEnum& enA,
FormalAliasEnum& enARef) {
this->enumArgsHookOverflowed_out(portNum, en, enRef, enA, enARef);
}