hierarchical-object-interface.h

Go to the documentation of this file.

// -*- mode: C++; c-file-style: "virtutech-c++" -*-
 
/*
  © 2022 Intel Corporation
 
  This software and the related documents are Intel copyrighted materials, and
  your use of them is governed by the express license under which they were
  provided to you ("License"). Unless the License provides otherwise, you may
  not use, modify, copy, publish, distribute, disclose or transmit this software
  or the related documents without Intel's prior written permission.
 
  This software and the related documents are provided as is, with no express or
  implied warranties, other than those that are expressly stated in the License.
*/
 
#ifndef SIMICS_HIERARCHICAL_OBJECT_INTERFACE_H
#define SIMICS_HIERARCHICAL_OBJECT_INTERFACE_H
 
#include <string>
#include <string_view>
 
#include "simics/conf-object.h"
 
namespace simics {
 
class MappableConfObject;
class FieldInterface;
class RegisterInterface;
class BankInterface;
 
enum class Level {BANK = 0, REGISTER = 1, FIELD = 2};
 
class HierarchicalObjectInterface {
  public:
    virtual const std::string &hierarchical_name() const = 0;
    virtual std::string_view name() const = 0;
    virtual const std::string &description() const = 0;
    virtual void set_description(std::string_view desc) = 0;
    virtual Level hierarchy_level() const = 0;
    virtual std::string_view bank_name() const = 0;
    virtual MappableConfObject *dev_obj() const = 0;
    virtual ConfObjectRef bank_obj_ref() const = 0;
    virtual std::string_view parent_name() const = 0;
    virtual FieldInterface *lookup_field(const std::string &name) const = 0;
    virtual RegisterInterface *lookup_register(
            const std::string &name) const = 0;
    virtual BankInterface *lookup_bank(const std::string &name) const = 0;
};
 
}  // namespace simics
 
#endif