IdentifiedObject.h

Go to the documentation of this file.

/* Copyright 2017-2021 Institute for Automation of Complex Power Systems,
 *                     EONERC, RWTH Aachen University
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 *********************************************************************************/
 
#pragma once
 
#include <dpsim-models/AttributeList.h>
#include <dpsim-models/Config.h>
#include <dpsim-models/Definitions.h>
#include <dpsim-models/Utils.h>
 
namespace CPS {
class IdentifiedObject {
protected:
  AttributeList::Ptr mAttributes = AttributeList::make();
 
public:
  const Attribute<String>::Ptr mName;
  const Attribute<String>::Ptr mUID;
 
  typedef std::shared_ptr<IdentifiedObject> Ptr;
  typedef std::vector<Ptr> List;
 
  IdentifiedObject() {}
 
  IdentifiedObject(const String &uid, const String &name)
      : mName(mAttributes->create("name", name)),
        mUID(mAttributes->create("uid", uid)) {}
 
  explicit IdentifiedObject(const String &name)
      : IdentifiedObject(name, name) {}
 
  virtual ~IdentifiedObject() = default;

  AttributeBase::Ptr attribute(const String &name) const {
    return mAttributes->attribute(name);
  }

  template <typename T>
  typename Attribute<T>::Ptr attributeTyped(const String &name) const {
    return mAttributes->attributeTyped<T>(name);
  }
 
  const AttributeBase::Map &attributes() const {
    return mAttributes->attributes();
  };
 
  String name() { return **mName; }
  String uid() { return **mUID; }
  String type() { return Utils::className(this); }
  // Returns a description of the object
  virtual String description() { return ""; }
};
} // namespace CPS