GlobalTreeNode.hpp

Go to the documentation of this file.

// <GlobalTreeNode> -*- C++ -*-
 
#pragma once
 
#include "sparta/simulation/TreeNode.hpp"
 
namespace sparta
{
    class GlobalTreeNode final : public TreeNode
    {
    public:
 
        static constexpr char GLOBAL_NODE_NAME[] = "_SPARTA_global_node_";
 
        GlobalTreeNode() :
            TreeNode(GLOBAL_NODE_NAME, GROUP_NAME_BUILTIN, GROUP_IDX_NONE, "Global space of device tree")
        { }
 
        virtual ~GlobalTreeNode() {};
 
        // Returns true. Tree root is always considered "attached"
        virtual bool isAttached() const override final {
            return true;
        }
 
        // Returns 0. Tree global node will never have a parent
        virtual TreeNode* getParent() override final { return nullptr; }
 
        // Returns 0. Tree global node will never have a parent
        virtual const TreeNode* getParent() const override final { return nullptr; }
 
        // Override from TreeNode
        // Virtual global node cannot generate any notifications!
        virtual bool canGenerateNotification_(const std::type_info&,
                                              const std::string*,
                                              const std::string*&) const override final {
            return false;
        }
 
        virtual std::string stringize(bool pretty=false) const override {
            (void) pretty;
            std::stringstream ss;
            ss << "<" << getName() << ">";
            return ss.str();
        }
 
    protected:
 
        // No effect on root
        virtual void createResource_() override {};
 
        virtual void setParent_(TreeNode* parent, bool) override {
            SpartaException ex("This GlobalTreeNode \"");
            ex << "\" cannot be a child of any other node. Someone attempted "
                  "to add it as a child of " << parent->getLocation();
            throw ex;
        }
    };
 
} // namespace sparta