src/model/Component_Impl.hpp
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /*********************************************************************************************************************** | ||
| 2 | * OpenStudio(R), Copyright (c) Alliance for Energy Innovation, LLC. | ||
| 3 | * See also https://openstudio.net/license | ||
| 4 | ***********************************************************************************************************************/ | ||
| 5 | |||
| 6 | #ifndef MODEL_COMPONENT_IMPL_HPP | ||
| 7 | #define MODEL_COMPONENT_IMPL_HPP | ||
| 8 | |||
| 9 | #include "Model_Impl.hpp" | ||
| 10 | |||
| 11 | namespace openstudio { | ||
| 12 | namespace model { | ||
| 13 | |||
| 14 | class ComponentData; | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | /** Implementation of Component. In addition to providing Component functionality, overrides | ||
| 19 | * most derived setters to avoid invalidating the Component. Also does not support SqlFile | ||
| 20 | * attachment. */ | ||
| 21 | class MODEL_API Component_Impl : public Model_Impl | ||
| 22 | { | ||
| 23 | |||
| 24 | public: | ||
| 25 | /** @name Constructors and Destructors */ | ||
| 26 | //@{ | ||
| 27 | |||
| 28 | // construct from IdfFile, used for deserialization | ||
| 29 | explicit Component_Impl(const IdfFile& idfFile); | ||
| 30 | |||
| 31 | // copy constructor, used for clone | ||
| 32 | Component_Impl(const Component_Impl& other, bool keepHandles = false); | ||
| 33 | |||
| 34 | /** Construct from subset of Model. Makes unconnected copy of all data, only keeping | ||
| 35 | * information about objects corresponding to handles. */ | ||
| 36 | Component_Impl(const Model_Impl& model, const std::vector<Handle>& hs); | ||
| 37 | |||
| 38 | /** Implementation of openstudio::detail::Workspace_Impl::clone for Component_Impl. The returned | ||
| 39 | * value may be cast to type Component. */ | ||
| 40 | virtual Workspace clone(bool keepHandles = false) const override; | ||
| 41 | |||
| 42 | /** Invalid to partially clone a Component. Always throws. In some cases, it may be possible to | ||
| 43 | * clone(), and then remove objects as desired. */ | ||
| 44 | virtual Workspace cloneSubset(const std::vector<Handle>& handles, bool keepHandles = false, | ||
| 45 | StrictnessLevel level = StrictnessLevel::Draft) const override; | ||
| 46 | |||
| 47 | // no swap method here because no component-level data | ||
| 48 | |||
| 49 | 266 | virtual ~Component_Impl() override = default; | |
| 50 | |||
| 51 | //@} | ||
| 52 | /** @name Getters */ | ||
| 53 | //@{ | ||
| 54 | |||
| 55 | /** Returns object that lists meta-data and contents of this Component. */ | ||
| 56 | ComponentData componentData() const; | ||
| 57 | |||
| 58 | /** Returns the primary ModelObject of this Component. Can be used to access the Component | ||
| 59 | * type by using .optionalCast and/or iddObject().type(). */ | ||
| 60 | ModelObject primaryObject() const; | ||
| 61 | |||
| 62 | //@} | ||
| 63 | /** @name Setters */ | ||
| 64 | //@{ | ||
| 65 | |||
| 66 | /** Override to return false. Components are always at Draft StrictnessLevel. */ | ||
| 67 | virtual bool setStrictnessLevel(StrictnessLevel level) override; | ||
| 68 | |||
| 69 | /** Override to return boost::none. */ | ||
| 70 | virtual boost::optional<WorkspaceObject> addObject(const IdfObject& idfObject) override; | ||
| 71 | |||
| 72 | /** Override to return boost::none. */ | ||
| 73 | virtual boost::optional<WorkspaceObject> insertObject(const IdfObject& idfObject) override; | ||
| 74 | |||
| 75 | /** Override to return empty vector. */ | ||
| 76 | virtual std::vector<WorkspaceObject> addObjects(const std::vector<IdfObject>& idfObjects, bool checkNames) override; | ||
| 77 | |||
| 78 | /** Override to return empty vector. */ | ||
| 79 | virtual std::vector<WorkspaceObject> insertObjects(const std::vector<IdfObject>& idfObjects) override; | ||
| 80 | |||
| 81 | /** Override to return empty vector. */ | ||
| 82 | virtual std::vector<WorkspaceObject> addAndInsertObjects(const std::vector<IdfObject>& objectsToAdd, | ||
| 83 | const std::vector<IdfObject>& objectsToInsert) override; | ||
| 84 | |||
| 85 | /** Override to return empty vector. */ | ||
| 86 | virtual std::vector<WorkspaceObject> addObjects(const std::vector<WorkspaceObject>& objects, bool checkNames) override; | ||
| 87 | |||
| 88 | /** Override to return empty vector. */ | ||
| 89 | virtual std::vector<WorkspaceObject> insertObjects(const std::vector<WorkspaceObject>& objects) override; | ||
| 90 | |||
| 91 | /** Override to return empty vector. */ | ||
| 92 | virtual std::vector<WorkspaceObject> addAndInsertObjects(const std::vector<WorkspaceObject>& objectsToAdd, | ||
| 93 | const std::vector<WorkspaceObject>& objectsToInsert) override; | ||
| 94 | |||
| 95 | /** Override to return empty vector. */ | ||
| 96 | virtual std::vector<WorkspaceObject> addAndInsertObjects(const std::vector<WorkspaceObject>& objectsToAdd, | ||
| 97 | const std::vector<std::vector<WorkspaceObject>>& objectsToInsert) override; | ||
| 98 | |||
| 99 | /** Override to return false. */ | ||
| 100 | virtual bool setSqlFile(const openstudio::SqlFile& sqlFile) override; | ||
| 101 | |||
| 102 | /** Override to return boost::none. */ | ||
| 103 | virtual boost::optional<ComponentData> insertComponent(const Component& component) override; | ||
| 104 | |||
| 105 | /** Override to return empty vector. */ | ||
| 106 | virtual std::vector<openstudio::IdfObject> purgeUnusedResourceObjects() override; | ||
| 107 | virtual std::vector<openstudio::IdfObject> purgeUnusedResourceObjects(IddObjectType iddObjectType) override; | ||
| 108 | |||
| 109 | //@} | ||
| 110 | /** @name Serialization */ | ||
| 111 | //@{ | ||
| 112 | |||
| 113 | /** Save Component to path. Will construct parent folder, but no further up the chain. Will | ||
| 114 | * only overwrite an existing file if overwrite==true. Will set extension to | ||
| 115 | * componentFileExtension(). */ | ||
| 116 | virtual bool save(const openstudio::path& p, bool overwrite = false) override; | ||
| 117 | |||
| 118 | //@} | ||
| 119 | |||
| 120 | virtual void obsoleteComponentWatcher(const ComponentWatcher& watcher) override; | ||
| 121 | |||
| 122 | private: | ||
| 123 | − | REGISTER_LOGGER("openstudio.model.Component"); | |
| 124 | }; | ||
| 125 | |||
| 126 | } // namespace detail | ||
| 127 | |||
| 128 | } // namespace model | ||
| 129 | } // namespace openstudio | ||
| 130 | |||
| 131 | #endif // MODEL_COMPONENT_IMPL_HPP | ||
| 132 |