DpDemo.cpp

Go to the documentation of this file.

// ======================================================================
// \title  DpDemo.cpp
// \author jawest
// \brief  cpp file for DpDemo component implementation class
// ======================================================================

#include "Ref/DpDemo/DpDemo.hpp"

namespace Ref {

// ----------------------------------------------------------------------
// Component construction and destruction
// ----------------------------------------------------------------------

DpDemo ::DpDemo(const char* const compName) : DpDemoComponentBase(compName) {
    this->selectedColor = DpDemo_ColorEnum::RED;
    this->numRecords = 0;
    this->dpPriority = 0;
    this->dpInProgress = false;
}

DpDemo ::~DpDemo() {}

// ----------------------------------------------------------------------
// Handler implementations for typed input ports
// ----------------------------------------------------------------------

void DpDemo ::run_handler(FwIndexType portNum, U32 context) {
    // If a Data product is being generated, store records
    if (this->dpInProgress) {
        this->dpContainer.serializeRecord_StringRecord(Fw::String("Test string"));
        this->dpContainer.serializeRecord_BooleanRecord(true);
        this->dpContainer.serializeRecord_I32Record(-100);
        this->dpContainer.serializeRecord_F64Record(1.25);
        this->dpContainer.serializeRecord_U32ArrayRecord(DpDemo_U32Array({1, 2, 3, 4, 5}));
        this->dpContainer.serializeRecord_F32ArrayRecord(DpDemo_F32Array({1.1f, 2.2f, 3.3f}));
        this->dpContainer.serializeRecord_BooleanArrayRecord(DpDemo_BooleanArray({true, false}));
        // Array Records
        // Array record of strings
        Fw::String str0("String array element 0");
        Fw::String str1("String array element 1");
        Fw::String str2("String array element 2");
        const Fw::StringBase* strings[3] = {&str0, &str1, &str2};
        this->dpContainer.serializeRecord_StringArrayRecord(strings, 3);
        // Array record of arrays
        const DpDemo_StringArray arrayArray[1] = {DpDemo_StringArray(
            {Fw::String("0 - String array record element 0"), Fw::String("0 - String array record element 1")})};
        this->dpContainer.serializeRecord_ArrayArrayRecord(arrayArray, 1);
        // Array record of structs
        const DpDemo_StructWithStringMembers structArray[2] = {
            DpDemo_StructWithStringMembers(Fw::String("0 - String member"),
                                           DpDemo_StringArray({Fw::String("0 - String array element 0"),
                                                               Fw::String("0 - String array element 1")})),
            DpDemo_StructWithStringMembers(Fw::String("1 - String member"),
                                           DpDemo_StringArray({Fw::String("1 - String array element 0"),
                                                               Fw::String("1 - String array element 1")}))};
        this->dpContainer.serializeRecord_StructArrayRecord(structArray, 2);
        this->dpContainer.serializeRecord_ArrayOfStringArrayRecord(DpDemo_ArrayOfStringArray(
            {DpDemo_StringArray({Fw::String("0 - String array element 0"), Fw::String("0 - String array element 1")}),
             DpDemo_StringArray({Fw::String("1 - String array element 0"), Fw::String("1 - String array element 1")}),
             DpDemo_StringArray(
                 {Fw::String("2 - String array element 0"), Fw::String("2 - String array element 1")})}));
        this->dpContainer.serializeRecord_ArrayOfStructsRecord(DpDemo_ArrayOfStructs(
            {DpDemo_StructWithStringMembers(Fw::String("0 - String member"),
                                            DpDemo_StringArray({Fw::String("0 - String array element 0"),
                                                                Fw::String("0 - String array element 1")})),
             DpDemo_StructWithStringMembers(Fw::String("1 - String member"),
                                            DpDemo_StringArray({Fw::String("1 - String array element 0"),
                                                                Fw::String("1 - String array element 1")})),
             DpDemo_StructWithStringMembers(Fw::String("2 - String member"),
                                            DpDemo_StringArray({Fw::String("2 - String array element 0"),
                                                                Fw::String("2 - String array element 1")}))}));
        this->dpContainer.serializeRecord_EnumArrayRecord(
            DpDemo_EnumArray({DpDemo_ColorEnum::RED, DpDemo_ColorEnum::GREEN, DpDemo_ColorEnum::BLUE}));
        this->dpContainer.serializeRecord_StructWithEverythingRecord(DpDemo_StructWithEverything(
            -1, 2.5, Fw::String("String Member"), false, this->selectedColor,
            {DpDemo_U32Array({1, 2, 3, 4, 5}), DpDemo_U32Array({6, 7, 8, 9, 10})}, DpDemo_F32Array({4.4f, 5.5f, 6.6f}),
            DpDemo_U32Array({6, 7, 8, 9, 10}),
            DpDemo_EnumArray({DpDemo_ColorEnum::RED, DpDemo_ColorEnum::GREEN, DpDemo_ColorEnum::BLUE}),
            DpDemo_StringArray({Fw::String("String array element 0"), Fw::String("String array element 1")}),
            DpDemo_BooleanArray({true, false}),
            DpDemo_StructWithStringMembers(
                Fw::String("String member"),
                DpDemo_StringArray({Fw::String("String array element 0"), Fw::String("String array element 1")})),
            DpDemo_ArrayOfStringArray({DpDemo_StringArray({Fw::String("0 - String array element 0"),
                                                           Fw::String("0 - String array element 1")}),
                                       DpDemo_StringArray({Fw::String("1 - String array element 0"),
                                                           Fw::String("1 - String array element 1")}),
                                       DpDemo_StringArray({Fw::String("2 - String array element 0"),
                                                           Fw::String("2 - String array element 1")})})));
        this->log_ACTIVITY_LO_DpComplete(this->numRecords);
        this->cleanupAndSendDp();
    }
}

// ----------------------------------------------------------------------
// Handler implementations for commands
// ----------------------------------------------------------------------

void DpDemo ::SelectColor_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Ref::DpDemo_ColorEnum& color) {
    this->selectedColor = color;
    log_ACTIVITY_HI_ColorSelected(color);
    this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
}

void DpDemo ::Dp_cmdHandler(FwOpcodeType opCode,
                            U32 cmdSeq,
                            const DpDemo_DpReqType& reqType,
                            U32 priority,
                            const Fw::DpCfg::ProcType& proc) {
    // make sure DPs are available
    if (!this->isConnected_productGetOut_OutputPort(0) || !this->isConnected_productRequestOut_OutputPort(0)) {
        this->log_WARNING_HI_DpsNotConnected();
        this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::EXECUTION_ERROR);
        return;
    }

    this->numRecords = 14;  // 14 records in current demo

    // Element counts for the variable length array records serialized below
    const FwSizeType stringArrayElements = 3;
    const FwSizeType arrayArrayElements = 1;
    const FwSizeType structArrayElements = 2;

    // The generated SIZE_OF_*_RECORD constants already account for the record
    // id, and for array records the serialized length prefix, so the demo no
    // longer has to reproduce the layout by hand
    FwSizeType dpSize = SIZE_OF_StringRecord_RECORD + SIZE_OF_BooleanRecord_RECORD + SIZE_OF_I32Record_RECORD +
                        SIZE_OF_F64Record_RECORD + SIZE_OF_U32ArrayRecord_RECORD + SIZE_OF_F32ArrayRecord_RECORD +
                        SIZE_OF_BooleanArrayRecord_RECORD + SIZE_OF_EnumArrayRecord_RECORD +
                        SIZE_OF_StructWithEverythingRecord_RECORD + SIZE_OF_ArrayOfStringArrayRecord_RECORD +
                        SIZE_OF_ArrayOfStructsRecord_RECORD + SIZE_OF_StringArrayRecord_RECORD(stringArrayElements) +
                        SIZE_OF_ArrayArrayRecord_RECORD(arrayArrayElements) +
                        SIZE_OF_StructArrayRecord_RECORD(structArrayElements);

    this->dpPriority = static_cast<FwDpPriorityType>(priority);
    this->dpProc = proc;
    this->log_ACTIVITY_LO_DpMemRequested(dpSize);
    if (reqType == DpDemo_DpReqType::IMMEDIATE) {
        Fw::Success stat = this->dpGet_DpDemoContainer(dpSize, this->dpContainer);
        // make sure we got the memory we wanted
        if (Fw::Success::FAILURE == stat) {
            this->log_WARNING_HI_DpMemoryFail();
            this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::EXECUTION_ERROR);
        } else {
            this->dpInProgress = true;
            this->log_ACTIVITY_LO_DpStarted(numRecords);
            this->log_ACTIVITY_LO_DpMemReceived(this->dpContainer.getBuffer().getSize());
            // override priority with requested priority
            this->dpContainer.setPriority(priority);
            this->dpContainer.setProcTypes(proc);
            this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
        }
    } else if (reqType == DpDemo_DpReqType::ASYNC) {
        // Response is deferred until the requested container arrives
        this->pendingOpCode = opCode;
        this->pendingCmdSeq = cmdSeq;
        this->dpRequest_DpDemoContainer(dpSize);
    } else {
        // should never get here
        FW_ASSERT(0, reqType.e);
    }
}

// ----------------------------------------------------------------------
// Handler implementations for data products
// ----------------------------------------------------------------------

void DpDemo ::dpRecv_DpDemoContainer_handler(DpContainer& container, Fw::Success::T status) {
    // Make sure we got the buffer we wanted or quit
    if (Fw::Success::SUCCESS == status) {
        this->dpContainer = container;
        this->dpInProgress = true;
        // set previously requested priority
        this->dpContainer.setPriority(this->dpPriority);
        this->dpContainer.setProcTypes(this->dpProc);
        this->log_ACTIVITY_LO_DpStarted(this->numRecords);
        this->cmdResponse_out(this->pendingOpCode, this->pendingCmdSeq, Fw::CmdResponse::OK);
    } else {
        this->log_WARNING_HI_DpMemoryFail();
        // cleanup
        this->dpInProgress = false;
        this->numRecords = 0;
        this->cmdResponse_out(this->pendingOpCode, this->pendingCmdSeq, Fw::CmdResponse::EXECUTION_ERROR);
    }
}

void DpDemo ::cleanupAndSendDp() {
    this->dpSend(this->dpContainer);
    this->dpInProgress = false;
    this->numRecords = 0;
}

}  // namespace Ref