isInitialized() and operator bool() for most of the objects. Bump to 1.4.0

Author: camilo

library.json

@@ -16,7 +16,7 @@
       "maintainer": true
     }
   ],
-  "version": "1.3.9",
+  "version": "1.4.0",
   "license": "MIT",
   "frameworks": "arduino",
   "platforms": "*"

library.properties

@@ -1,5 +1,5 @@
 name=qlibs
-version=1.3.9
+version=1.4.0
 license=MIT
 author=J. Camilo Gomez C. <[email protected]>
 maintainer=J. Camilo Gomez C. <[email protected]>

src/CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required( VERSION 3.2 )
 project( qlibs-cpp
-         VERSION 1.3.9
+         VERSION 1.4.0
          DESCRIPTION "A collection of useful C++ libraries for embedded systems"
          LANGUAGES CXX )
 

src/include/bitfield.hpp

@@ -213,6 +213,22 @@ namespace qlibs {
             */
             void* dump( void * const dst,
                         const size_t n ) noexcept;
+
+            /**
+            * @brief Check if the bit-field instance has been initialized.
+            * @return @c true if instance has been initialized
+            */
+            bool isInitialized( void ) const {
+                return ( nullptr != field );
+            }
+
+            /**
+            * @brief Check if the bit-field instance has been initialized.
+            * @return @c true if instance has been initialized
+            */
+            explicit operator bool() const noexcept {
+                return isInitialized();
+            }
     };
 
     /** @}*/

src/include/fis.hpp

@@ -814,6 +814,22 @@ namespace qlibs {
             */
             bool setRuleWeights( real_t *rWeights ) noexcept;
 
+            /**
+            * @brief Check if the FIS instance has been initialized.
+            * @return @c true if instance has been initialized
+            */
+            bool isInitialized( void ) const {
+                return ( nullptr != xInput );
+            }
+
+            /**
+            * @brief Check if the FIS instance has been initialized.
+            * @return @c true if instance has been initialized
+            */
+            explicit operator bool() const noexcept {
+                return isInitialized();
+            }
+
             /**
             * @brief Get the number of points used on Mamdani to perform the
             * de-fuzzification proccess
@@ -1207,6 +1223,23 @@ namespace qlibs {
                 }
                 return *this;
             }
+
+            /**
+            * @brief Check if the FIS system has been initialized.
+            * @return @c true if instance has been initialized
+            */
+            bool isInitialized( void ) const {
+                return sys.isInitialized();
+            }
+
+            /**
+            * @brief Check if the FIS system has been initialized.
+            * @return @c true if instance has been initialized
+            */
+            explicit operator bool() const noexcept {
+                return sys.isInitialized();
+            }
+
     };
         /** @}*/
     }

src/include/ltisys.hpp

@@ -373,6 +373,16 @@ namespace qlibs {
             */
             virtual bool isInitialized( void ) const = 0;
 
+
+            /**
+            * @brief Check if the LTI system is initialized.
+            * @return @c true if the system has been initialized, otherwise
+            * return @c false.
+            */
+            explicit operator bool() const noexcept {
+                return isInitialized();
+            }
+
             /**
             * @brief Set the initial states for the given system
             * @pre System should be previously initialized by using the @c setup() method
@@ -577,6 +587,15 @@ namespace qlibs {
                 return ( nullptr != xd ) && ( LTISYS_TYPE_DISCRETE == type );
             }
 
+            /**
+            * @brief Check if the LTI discrete system is initialized.
+            * @return @c true if the system has been initialized, otherwise
+            * return @c false.
+            */
+            explicit operator bool() const noexcept {
+                return isInitialized();
+            }
+
             /**
             * @brief Set the initial states for the discrete system
             * @pre System should be previously initialized by using the

src/include/numa.hpp

@@ -258,6 +258,12 @@ namespace qlibs {
             * @note This should be called at intervals equal to the time step provided in the constructor.
             */
             real_t operator()( const real_t xDot );
+
+            /**
+            * @brief Retrieve the current value of the integration
+            * @return The current value of the integral.
+            */
+            real_t operator()() const;
     };
 
     /**

src/include/pid.hpp

@@ -449,6 +449,15 @@ namespace qlibs {
             {
                 return { Kc, Ki, Kd };
             }
+
+            /**
+            * @brief Check if the PID instance has been initialized using setup().
+            * @return @c true if the PID instance has been initialized, otherwise
+            * return @c false.
+            */
+            explicit operator bool() const noexcept {
+                return isInitialized;
+            }
     };
 
     /** @}*/

src/include/rms.hpp

@@ -68,6 +68,15 @@ namespace qlibs {
                 return setup( win, windowSize );
             }
 
+            /**
+            * @brief Check if the RMS instance has been initialized using setup().
+            * @return @c true if the RMS instance has been initialized, otherwise
+            * return @c false.
+            */
+            explicit operator bool() const noexcept {
+                return smootherLPF1::isInitialized(); // controls truthiness
+            }
+
             /**
             * @brief Change the recursive parameters for the moving RMS estimator.
             * @param[in] l Exponential weighting factor, specified as a positive

src/include/smoother.hpp

@@ -28,6 +28,7 @@ namespace qlibs {
         protected:
             /*! @cond  */
             bool init{ true };
+            bool isSetup{ false };
             static void windowSet( real_t *w,
                                    const size_t wsize,
                                    const real_t x );
@@ -36,11 +37,24 @@ namespace qlibs {
             virtual ~smoother() {}
 
             /**
-            * @brief Check if the smoother filter is initialized.
+            * @brief Check if the smoother filter has been initialized using setup().
             * @return @c true if the smoother has been initialized, otherwise
             * return @c false.
             */
-            bool isInitialized( void ) const;
+            bool isInitialized( void ) const
+            {
+                return isSetup;
+            }
+
+            /**
+            * @brief Check if the smoother filter has been initialized using setup().
+            * @return @c true if the smoother has been initialized, otherwise
+            * return @c false.
+            */
+            explicit operator bool() const noexcept
+            {
+                return isInitialized();
+            }
 
             /**
             * @brief Perform the smooth operation recursively for the input signal @a x.