text: //  MIT License
  //
  //  Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
  //  Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
  //
  //  Permission is hereby granted, free of charge, to any person obtaining a copy
  //  of this software and associated documentation files (the "Software"), to deal
  //  in the Software without restriction, including without limitation the rights
  //  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  //  copies of the Software, and to permit persons to whom the Software is
  //  furnished to do so, subject to the following conditions:
  //
  //  The above copyright notice and this permission notice shall be included in all
  //  copies or substantial portions of the Software.
  //
  //  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  //  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  //  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  //  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  //  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  //  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  //  SOFTWARE.
  
  #pragma once
  
  #include "hal_core/netlist/gate_library/gate_type_component/gate_type_component.h"
  
  namespace hal
  {
      class RAMComponent : public GateTypeComponent
      {
      public:
          /**
           * Construct a new RAMComponent with given child component.
           * 
           * @param[in] component - Another component to be added as a child component.
           * @param[in] bit_size - The size of the RAM in bits.
           */
          RAMComponent(std::unique_ptr<GateTypeComponent> component, const u32 bit_size);
  
          /**
           * Get the type of the gate type component.
           * 
           * @returns The type of the gate type component.
           */
          ComponentType get_type() const override;
  
          /**
           * Check whether a component is a RAMComponent.
           * 
           * @param[in] component - The component to check.
           * @returns True if component is a RAMComponent, false otherwise.
           */
          static bool is_class_of(const GateTypeComponent* component);
  
          /**
           * Get the sub-components of the gate type component.
           * A user-defined filter may be applied to the result vector, but is disabled by default.
           * 
           * @param[in] filter - The user-defined filter function applied to all candidate components.
           * @returns The sub-components of the gate type component.
           */
          std::vector<GateTypeComponent*> get_components(const std::function<bool(const GateTypeComponent*)>& filter = nullptr) const override;
  
          // TODO pybinds and tests
  
          /**
           * Get the size of the RAM in bits.
           * 
           * @returns The size of the RAM in bits.
           */
          u32 get_bit_size() const;
  
          /**
           * Set the size of the RAM in bits.
           * 
           * @param[in] bit_size - The size of the RAM in bits.
           */
          void set_bit_size(const u32 bit_size);
  
      private:
          static constexpr ComponentType m_type          = ComponentType::ram;
          std::unique_ptr<GateTypeComponent> m_component = nullptr;
  
          u32 m_bit_size;
      };
  }    // namespace hal