compartment.hpp

Go to the documentation of this file.

/*
 * Copyright 2023 Blue Brain Project, EPFL.
 * See the top-level LICENSE file for details.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
///
/// THIS FILE IS GENERATED AT BUILD TIME AND SHALL NOT BE EDITED.
///
 
#pragma once
 
/**
 * \dir
 * \brief Auto generated AST Implementations
 *
 * \file
 * \brief Auto generated AST classes declaration
 */
 
#include "ast/ast_decl.hpp"
#include "ast/name.hpp"
#include "ast/statement.hpp"
 
namespace nmodl::ast {
 
/**
 * \addtogroup ast_class
 * \ingroup ast
 * \{
 */
 
/**
 * \brief Represent COMPARTMENT statement in NMODL
 *
 * 
*/
class Compartment : public Statement {
  private:
    /// Name of the index variable in volume expression
    std::shared_ptr<Name> index_name;
    /// The volume of the compartment
    std::shared_ptr<Expression> volume;
    /// The names of the species that reside in this compartment
    NameVector species;
    /// token with location information
    std::shared_ptr<ModToken> token;
 
  public:
  /// \name Ctor & dtor
  /// \{
    explicit Compartment(Name* index_name, Expression* volume, const NameVector& species);
    explicit Compartment(std::shared_ptr<Name> index_name, std::shared_ptr<Expression> volume, const NameVector& species);
    Compartment(const Compartment& obj);
    virtual ~Compartment() = default;
  /// \}
  
  /**
   * \brief Check if the ast node is an instance of ast::Compartment
   * \return true as object is of type ast::Compartment
   */
  bool is_compartment () const noexcept override {
    return true;
  }
 
  /**
   * \brief Return a copy of the current node
   *
   * Recursively make a new copy/clone of the current node including
   * all members and return a pointer to the node. This is used for
   * passes like nmodl::visitor::InlineVisitor where nodes are cloned in the
   * ast.
   *
   * \return pointer to the clone/copy of the current node
   */
  // NOLINTBEGIN(clang-analyzer-cplusplus.NewDeleteLeaks)
  Compartment* clone() const override {
    return new Compartment(*this);
  }
  // NOLINTEND(clang-analyzer-cplusplus.NewDeleteLeaks)
 
  /// \name Getters
  /// \{
 
  /**
   * \brief Return type (ast::AstNodeType) of ast node
   *
   * Every node in the ast has a type defined in ast::AstNodeType and this
   * function is used to retrieve the same.
   *
   * \return ast node type i.e. ast::AstNodeType::COMPARTMENT
   *
   * \sa Ast::get_node_type_name
   */
  AstNodeType get_node_type() const noexcept override {
    return AstNodeType::COMPARTMENT;
  }
 
  /**
   * \brief Return type (ast::AstNodeType) of ast node as std::string
   *
   * Every node in the ast has a type defined in ast::AstNodeType.
   * This type name can be returned as a std::string for printing
   * node to text/json form.
   *
   * \return name of the node type as a string i.e. "Compartment"
   *
   * \sa Ast::get_node_name
   */
  std::string get_node_type_name() const noexcept override {
    return "Compartment";
  }
 
    /**
     * \brief Return NMODL statement of ast node as std::string
     *
     * Every node is related to a special statement in the NMODL. This
     * statement can be returned as a std::string for printing to
     * text/json form.
     *
     * \return name of the statement as a string i.e. "COMPARTMENT"
     *
     * \sa Ast::get_nmodl_name
     */
    std::string get_nmodl_name() const noexcept override {
      return "COMPARTMENT";
    }
 
  /**
   * \brief Get std::shared_ptr from `this` pointer of the current ast node
   */
  std::shared_ptr<Ast> get_shared_ptr() override {
    return std::static_pointer_cast<Compartment>(shared_from_this());
  }
 
  /**
   * \brief Get std::shared_ptr from `this` pointer of the current ast node
   */
  std::shared_ptr<const Ast> get_shared_ptr() const override {
    return std::static_pointer_cast<const Compartment>(shared_from_this());
  }
 
  /**
   * \brief Return associated token for the current ast node
   *
   * Not all ast nodes have token information. For example, nmodl::visitor::NeuronSolveVisitor
   * can insert new nodes in the ast as a solution of ODEs. In this case, we return
   * nullptr to store in the nmodl::symtab::SymbolTable.
   *
   * \return pointer to token if exist otherwise nullptr
   */
  const ModToken* get_token() const noexcept override {
    return token.get();
  }
  
  
  
  /**
   * \brief Getter for member variable \ref Compartment.index_name
   */
  std::shared_ptr<Name> get_index_name() const noexcept  {
    return index_name;
  }
  
  
  
  /**
   * \brief Getter for member variable \ref Compartment.volume
   */
  std::shared_ptr<Expression> get_volume() const noexcept  {
    return volume;
  }
  
  
  
  /**
   * \brief Getter for member variable \ref Compartment.species
   */
  const NameVector& get_species() const noexcept  {
    return species;
  }
  /// \}
 
  /// \name Setters
  /// \{
  /**
   * \brief Set token for the current ast node
   */
  void set_token(const ModToken& tok) { token = std::make_shared<ModToken>(tok); }
  
  /**
   * \brief Setter for member variable \ref Compartment.index_name (rvalue reference)
   */
  void set_index_name(std::shared_ptr<Name>&& index_name);
 
  /**
   * \brief Setter for member variable \ref Compartment.index_name
   */
  void set_index_name(const std::shared_ptr<Name>& index_name);
 
  
  /**
   * \brief Setter for member variable \ref Compartment.volume (rvalue reference)
   */
  void set_volume(std::shared_ptr<Expression>&& volume);
 
  /**
   * \brief Setter for member variable \ref Compartment.volume
   */
  void set_volume(const std::shared_ptr<Expression>& volume);
 
  
  /**
   * \brief Setter for member variable \ref Compartment.species (rvalue reference)
   */
  void set_species(NameVector&& species);
 
  /**
   * \brief Setter for member variable \ref Compartment.species
   */
  void set_species(const NameVector& species);
 
  /// \}
 
  /// \name Visitor
  /// \{
  /**
   * \brief visit children i.e. member variables of current node using provided visitor
   *
   * Different nodes in the AST have different members (i.e. children). This method
   * recursively visits children using provided visitor.
   *
   * \param v Concrete visitor that will be used to recursively visit children
   *
   * \sa Ast::visit_children for example.
   */
  void visit_children(visitor::Visitor& v) override;
 
  /**
   * \brief visit children i.e. member variables of current node using provided visitor
   *
   * Different nodes in the AST have different members (i.e. children). This method
   * recursively visits children using provided visitor.
   *
   * \param v Concrete constant visitor that will be used to recursively visit children
   *
   * \sa Ast::visit_children for example.
   */
  void visit_children(visitor::ConstVisitor& v) const override;
 
  /**
   * \brief accept (or visit) the current AST node using provided visitor
   *
   * Instead of visiting children of AST node, like Ast::visit_children,
   * accept allows to visit the current node itself using provided concrete
   * visitor.
   *
   * \param v Concrete visitor that will be used to recursively visit node
   *
   * \sa Ast::accept for example.
   */
  void accept(visitor::Visitor& v) override;
 
  /**
   * \copydoc accept(visitor::Visitor&)
   */
  void accept(visitor::ConstVisitor& v) const override;
  /// \}
 
  private:
    /**
     * \brief Set this object as parent for all the children
     *
     * This should be called in every object (with children) constructor
     * to set parents. Since it is called only in the constructors it
     * should not be virtual to avoid ambiguities (issue #295).
     */
     void set_parent_in_children();
};
 
/** \} */  // end of ast_class
 
  
  
  
 
}  // namespace nmodl::ast