port.h

Go to the documentation of this file.

// -*- mode: C++; c-file-style: "virtutech-c++" -*-
 
/*
  © 2021 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_PORT_H
#define SIMICS_PORT_H
 
#include <stdexcept>
#include <string>
 
#include "simics/conf-object.h"
#include "simics/utility.h"  // array_index
 
namespace simics {
 
template <typename TParent>
class Port : public ConfObject {
  public:
    using ParentType = TParent;
 
    explicit Port(const ConfObjectRef &obj)
        : ConfObject(obj) {
        if (obj.object() == nullptr) {
            throw std::invalid_argument(
                "ConfObjectRef passed to Port constructor is null");
        }
 
        parent_ = from_obj<ParentType>(parent_conf_obj());
        name_ = obj.name().substr(
            strlen(SIM_object_name(parent_conf_obj())) + 1);
        index_ = array_index(name_);
    }
    virtual ~Port() = default;
 
    ParentType *parent() const {
        return parent_;
    }
 
    const std::string &name() const {
        return name_;
    }
 
    int index() const {
        return index_;
    }
 
  private:
    conf_object_t *parent_conf_obj() {
        auto p = SIM_port_object_parent(obj());
        if (p == nullptr) {
            throw std::runtime_error {
                "The object " + obj().name() + " is not a port object"
            };
        }
        return p;
    }
 
    TParent *parent_ {nullptr};
    std::string name_ {""};
    int index_ {-1};
};
 
}  // namespace simics
 
#endif