Added EProbes GAM

Signed-off-by: Bernardo Carvalho <bernardo.carvalho@tecnico.ulisboa.pt>
2024-11-18 00:41:04 +00:00
parent 762316bbc8
commit 3b890ca623
4 changed files with 468 additions and 0 deletions
--- a/GAMs/ElectricProbesGAM/ElectricProbesGAM.h
+++ b/GAMs/ElectricProbesGAM/ElectricProbesGAM.h
@@ -0,0 +1,135 @@
+/**
+ * @file ElectricProbesGAM.h
+ * @brief Header file for class ElectricProbesGAM
+ * @date 06/04/2018
+ * @author Andre Neto
+ *
+ * @copyright Copyright 2015 F4E | European Joint Undertaking for ITER and
+ * the Development of Fusion Energy ('Fusion for Energy').
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved
+ * by the European Commission - subsequent versions of the EUPL (the "Licence")
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl
+ *
+ * @warning Unless required by applicable law or agreed to in writing, 
+ * software distributed under the Licence is distributed on an "AS IS"
+ * basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the Licence permissions and limitations under the Licence.
+
+ * @details This header file contains the declaration of the class ElectricProbesGAM
+ * with all of its public, protected and private members. It may also include
+ * definitions for inline methods which need to be visible to the compiler.
+ */
+
+#ifndef ELECTRICPROBESGAM_H_
+#define ELECTRICPROBESGAM_H_
+
+/*---------------------------------------------------------------------------*/
+/*                        Standard header includes                           */
+/*---------------------------------------------------------------------------*/
+
+/*---------------------------------------------------------------------------*/
+/*                        Project header includes                            */
+/*---------------------------------------------------------------------------*/
+
+#include "GAM.h"
+#include "MessageI.h"
+
+/*---------------------------------------------------------------------------*/
+/*                           Class declaration                               */
+/*---------------------------------------------------------------------------*/
+namespace MARTeIsttok {
+/**
+ * @brief An example of a GAM which has fixed inputs and outputs.
+ *
+ * @details This GAM multiplies the input signal by a Gain.
+ * The configuration syntax is (names and types are only given as an example):
+ *
+ * +GAMElectricProbes = {
+ *     Class = ElectricProbesGAM
+ *     Gain = 5 //Compulsory
+ *     InputSignals = {
+ *         Signal1 = {
+ *             DataSource = "DDB1"
+ *             Type = uint32
+ *         }
+ *     }
+ *     OutputSignals = {
+ *         Signal1 = {
+ *             DataSource = "DDB1"
+ *             Type = uint32
+ *         }
+ *     }
+ * }
+ */
+class ElectricProbesGAM : public MARTe::GAM, public MARTe::MessageI {
+public:
+    CLASS_REGISTER_DECLARATION()
+    /**
+     * @brief Constructor. NOOP.
+     */
+    ElectricProbesGAM();
+
+    /**
+     * @brief Destructor. NOOP.
+     */
+    virtual ~ElectricProbesGAM();
+
+    /**
+     * @brief Reads the Gain from the configuration file.
+     * @param[in] data see GAM::Initialise. The parameter Gain shall exist and will be read as an uint32.
+     * @return true if the parameter Gain can be read.
+     */
+    virtual bool Initialise(MARTe::StructuredDataI & data);
+
+    /**
+     * @brief Verifies correctness of the GAM configuration.
+     * @details Checks that the number of input signals is equal to the number of output signals is equal to one and that the same type is used.
+     * @return true if the pre-conditions are met.
+     * @pre
+     *   SetConfiguredDatabase() &&
+     *   GetNumberOfInputSignals() == GetNumberOfOutputSignals() == 1 &&
+     *   GetSignalType(InputSignals, 0) == GetSignalType(OutputSignals, 0) == uint32 &&
+     *   GetSignalNumberOfDimensions(InputSignals, 0) == GetSignalNumberOfDimensions(OutputSignals, 0) == 0 &&
+     *   GetSignalNumberOfSamples(InputSignals, 0) == GetSignalNumberOfSamples(OutputSignals, 0) == 1 &&
+     *   GetSignalNumberOfElements(InputSignals, 0) == GetSignalNumberOfElements(OutputSignals, 0) == 1
+     */
+    virtual bool Setup();
+
+    /**
+     * @brief Multiplies the input signal by the Gain.
+     * @return true.
+     */
+    virtual bool Execute();
+
+    /**
+     * @brief Export information about the component
+     */
+    virtual bool ExportData(MARTe::StructuredDataI & data);
+
+private:
+
+    /**
+     * The input signals
+     */
+    MARTe::float32 **inputSignals;
+
+    /**
+     * The output signals
+     */
+    MARTe::float32 **outputSignals;
+    MARTe::float32 *outputSignal1;
+
+
+    /**
+     * The configured gain.
+     */
+    MARTe::uint32 gain;
+};
+}
+/*---------------------------------------------------------------------------*/
+/*                        Inline method definitions                          */
+/*---------------------------------------------------------------------------*/
+
+#endif /* ELECTRICPROBESGAM_H_ */
+