Use FBContainer for all Function Blocks

As basic and simple fbs can have FBs as children and to reduce a lot of code complexity in the FBContainer all FBs are now FBContainers.
eclipse-4diac · Jul 25, 2024 · 7df4714 · 7df4714
1 parent 91b9831
commit 7df4714
Show file tree

Hide file tree

Showing 46 changed files with 331 additions and 481 deletions.
diff --git a/src/arch/be_m1/fortemodule.cpp b/src/arch/be_m1/fortemodule.cpp
@@ -247,7 +247,7 @@ SINT32 CFORTEModule::AppEOI(VOID){
  *-------------------------------------------------------------------------*/
 SINT32 CFORTEModule::AppStop(VOID){
   if(0 != mDev){
-    mDev->changeFBExecutionState(EMGMCommandType::Stop);
+    mDev->changeExecutionState(EMGMCommandType::Stop);
   }
 
   return OK;

diff --git a/src/core/basicfb.cpp b/src/core/basicfb.cpp
@@ -103,24 +103,6 @@ CIEC_ANY* CBasicFB::getInternalVar(CStringDictionary::TStringId paInternalName)
   return retVal;
 }
 
-TFunctionBlockPtr *CBasicFB::createInternalFBs(const size_t paAmountOfInternalFBs, const SCFB_FBInstanceData *const paInternalFBData, forte::core::CFBContainer &paContainer) {
-  TFunctionBlockPtr *internalFBs = nullptr;
-  if (paAmountOfInternalFBs) {
-    internalFBs = new TFunctionBlockPtr[paAmountOfInternalFBs];
-    for(size_t i = 0; i < paAmountOfInternalFBs; ++i) {
-      internalFBs[i] = CTypeLib::createFB(paInternalFBData[i].mFBInstanceNameId, paInternalFBData[i].mFBTypeNameId, paContainer);
-    }
-  }
-  return internalFBs;
-}
-
-void CBasicFB::deleteInternalFBs(const size_t paAmountOfInternalFBs, TFunctionBlockPtr *const paInternalFBs) {
-  for (size_t i = 0; i < paAmountOfInternalFBs; ++i) {
-    delete paInternalFBs[i];
-  }
-  delete[] paInternalFBs;
-};
-
 int CBasicFB::toString(char *paValue, size_t paBufferSize) const {
   int usedBuffer = CFunctionBlock::toString(paValue, paBufferSize);
   if (usedBuffer < 1 || cmVarInternals == nullptr || (cmVarInternals != nullptr && cmVarInternals->mNumIntVars == 0)) {

diff --git a/src/core/basicfb.h b/src/core/basicfb.h
@@ -69,29 +69,9 @@ class CBasicFB : public CFunctionBlock {
       return const_cast<CBasicFB *>(this)->getVarInternal(paVarIntNum);
     }
 
-    virtual size_t getInternalFBNum() const {
-      return 0;
-    }
-
-    virtual const SCFB_FBInstanceData *getInternalFBDefinition(size_t) const {
-      return nullptr;
-    }
-
-    virtual CFunctionBlock *getInternalFB(size_t) {
-      return nullptr;
-    }
-
-    const CFunctionBlock *getInternalFB(size_t paIntFBNum) const {
-      return const_cast<CBasicFB *>(this)->getInternalFB(paIntFBNum);
-    }
-
     CIEC_STATE mECCState; //! the current state of the ecc. start value is 0 = initial state id
     const SInternalVarsInformation *const cmVarInternals; //!< struct holding the information on the internal vars.
 
-    static TFunctionBlockPtr *createInternalFBs(const size_t paAmountOfInternalFBs, const SCFB_FBInstanceData *const pa_InternalFBData, forte::core::CFBContainer &paContainer);
-
-    static void deleteInternalFBs(const size_t paAmountOfInternalFBs, TFunctionBlockPtr *paInternalFBs);
-
     static size_t calculateBasicFBVarsDataSize(const SInternalVarsInformation &paVarInternals);
 
     void *mBasicFBVarsData;

diff --git a/src/core/cfb.cpp b/src/core/cfb.cpp
@@ -25,7 +25,6 @@
 CCompositeFB::CCompositeFB(forte::core::CFBContainer &paContainer, const SFBInterfaceSpec *paInterfaceSpec,
                            CStringDictionary::TStringId paInstanceNameId, const SCFB_FBNData & paFBNData) :
         CFunctionBlock(paContainer, paInterfaceSpec, paInstanceNameId),
-        forte::core::CFBContainer(paInstanceNameId, paContainer, paFBNData.mNumFBs),
         mIf2InDConns(nullptr),
         mIn2IfDConns(nullptr),
         cmFBNData(paFBNData),
@@ -117,38 +116,16 @@ bool CCompositeFB::configureGenericDO(TPortId paDOPortId, const CIEC_ANY &paRefV
   return bRetVal;
 }
 
-EMGMResponse CCompositeFB::changeFBExecutionState(EMGMCommandType paCommand){
-  EMGMResponse nRetVal = CFunctionBlock::changeFBExecutionState(paCommand);
-  if (EMGMResponse::Ready == nRetVal) {
-    nRetVal = CFBContainer::changeContainedFBsExecutionState(paCommand);
-  }
+EMGMResponse CCompositeFB::changeExecutionState(EMGMCommandType paCommand){
+  EMGMResponse nRetVal = CFunctionBlock::changeExecutionState(paCommand);
+
   //Update FB parameters that maybe got overwritten by default values of the FB
   if((EMGMCommandType::Reset == paCommand) && (E_FBStates::Idle == getState())){
     setParams();
   }
   return nRetVal;
 }
 
-#ifdef FORTE_SUPPORT_MONITORING
-
-CFunctionBlock *CCompositeFB::getFB(forte::core::TNameIdentifier::CIterator &paNameListIt){
-  CFunctionBlock *retVal = forte::core::CFBContainer::getFB(*paNameListIt);
-
-  if(retVal != nullptr){
-      if(!paNameListIt.isLastEntry()){
-         //we are looking for a child of this fB
-        ++paNameListIt;
-        retVal = retVal->getFB(paNameListIt);
-      }
-  } else {
-    //check if it is an adapter of the function block
-    retVal = CFunctionBlock::getFB(paNameListIt);
-  }
-  return retVal;
-}
-
-#endif
-
 CIEC_ANY *CCompositeFB::getVar(CStringDictionary::TStringId *paNameList, unsigned int paNameListSize){
   CIEC_ANY *retVal = nullptr;
 

diff --git a/src/core/cfb.h b/src/core/cfb.h
@@ -80,7 +80,7 @@ GENERATE_CONNECTION_PORT_ID_2_ARG(CStringDictionary::scmInvalidStringId, PortNam
 /*!\ingroup CORE
  * \brief Class for handling firmware composite function blocks.
  */
-class CCompositeFB: public CFunctionBlock, public forte::core::CFBContainer {
+class CCompositeFB: public CFunctionBlock {
 
   public:
     /*! \brief Indicator that the given FB id is an adapter.
@@ -124,11 +124,7 @@ class CCompositeFB: public CFunctionBlock, public forte::core::CFBContainer {
     CIEC_ANY* getVar(CStringDictionary::TStringId *paNameList,
         unsigned int paNameListSize) override;
 
-    EMGMResponse changeFBExecutionState(EMGMCommandType paCommand) override;
-
-#ifdef FORTE_SUPPORT_MONITORING
-    CFunctionBlock *getFB(forte::core::TNameIdentifier::CIterator &paNameListIt) override;
-#endif
+    EMGMResponse changeExecutionState(EMGMCommandType paCommand) override;
 
   protected:
     CDataConnection *getIn2IfConUnchecked(TPortId paIndex) {

diff --git a/src/core/cominfra/basecommfb.cpp b/src/core/cominfra/basecommfb.cpp
@@ -50,8 +50,8 @@ CBaseCommFB::~CBaseCommFB() {
   }
 }
 
-EMGMResponse CBaseCommFB::changeFBExecutionState(EMGMCommandType paCommand) {
-  EMGMResponse retVal = CEventSourceFB::changeFBExecutionState(paCommand);
+EMGMResponse CBaseCommFB::changeExecutionState(EMGMCommandType paCommand) {
+  EMGMResponse retVal = CEventSourceFB::changeExecutionState(paCommand);
   if ((EMGMResponse::Ready == retVal) && (EMGMCommandType::Kill == paCommand)) {
     //when we are killed we'll close the connection so that it can safely be opened again after an reset
     closeConnection();

diff --git a/src/core/cominfra/basecommfb.h b/src/core/cominfra/basecommfb.h
@@ -34,7 +34,7 @@ namespace forte {
     public:
       ~CBaseCommFB() override;
 
-      EMGMResponse changeFBExecutionState(EMGMCommandType paCommand) override;
+      EMGMResponse changeExecutionState(EMGMCommandType paCommand) override;
 
       forte::com_infra::EComServiceType getComServiceType() const {
         return mCommServiceType;

diff --git a/src/core/cominfra/commfb.cpp b/src/core/cominfra/commfb.cpp
@@ -43,8 +43,8 @@ CCommFB::CCommFB(const CStringDictionary::TStringId paInstanceNameId, forte::cor
 
 CCommFB::~CCommFB() = default;
 
-EMGMResponse CCommFB::changeFBExecutionState(EMGMCommandType paCommand) {
-  EMGMResponse retVal = CEventSourceFB::changeFBExecutionState(paCommand);
+EMGMResponse CCommFB::changeExecutionState(EMGMCommandType paCommand) {
+  EMGMResponse retVal = CEventSourceFB::changeExecutionState(paCommand);
   if ((EMGMResponse::Ready == retVal) && (EMGMCommandType::Kill == paCommand)) {
     //when we are killed we'll close the connection so that it can safely be opened again after an reset
     closeConnection();

diff --git a/src/core/cominfra/commfb.h b/src/core/cominfra/commfb.h
@@ -30,7 +30,7 @@ namespace forte {
     public:
       ~CCommFB() override;
 
-      EMGMResponse changeFBExecutionState(EMGMCommandType paCommand) override;
+      EMGMResponse changeExecutionState(EMGMCommandType paCommand) override;
 
     protected:
       CCommFB(const CStringDictionary::TStringId paInstanceNameId, forte::core::CFBContainer &paContainer, forte::com_infra::EComServiceType paCommServiceType);

diff --git a/src/core/device.cpp b/src/core/device.cpp
@@ -24,7 +24,7 @@ EMGMResponse CDevice::executeMGMCommand(forte::core::SManagementCMD &paCommand){
     retval = CResource::executeMGMCommand(paCommand);
   }
   else{
-    CResource *res = static_cast<CResource *>(CFBContainer::getFB(paCommand.mDestination));
+    CResource *res = static_cast<CResource *>(CFBContainer::getChild(paCommand.mDestination));
     if(nullptr != res){
       paCommand.mDestination = CStringDictionary::scmInvalidStringId;
       retval = res->executeMGMCommand(paCommand);
@@ -33,9 +33,9 @@ EMGMResponse CDevice::executeMGMCommand(forte::core::SManagementCMD &paCommand){
   return retval;
 }
 
-EMGMResponse CDevice::changeFBExecutionState(EMGMCommandType paCommand){
+EMGMResponse CDevice::changeExecutionState(EMGMCommandType paCommand){
   if(EMGMCommandType::Kill == paCommand){
     mDeviceExecution.disableHandlers();
   }
-  return CResource::changeFBExecutionState(paCommand);
+  return CResource::changeExecutionState(paCommand);
 }
diff --git a/src/core/device.h b/src/core/device.h
@@ -42,7 +42,7 @@ class CDevice : public CResource {
      *  \return 0 on success -1 on error
      */
     virtual int startDevice() {
-      changeFBExecutionState(EMGMCommandType::Start);
+      changeExecutionState(EMGMCommandType::Start);
       return 1;
     }
 
@@ -65,7 +65,7 @@ class CDevice : public CResource {
      */
     EMGMResponse executeMGMCommand(forte::core::SManagementCMD &paCommand) override;
 
-    EMGMResponse changeFBExecutionState(EMGMCommandType paCommand) override;
+    EMGMResponse changeExecutionState(EMGMCommandType paCommand) override;
 
     //! Retrieve the device execution of this device
     CDeviceExecution &getDeviceExecution() {