PlantComponentUserDefined.cpp

/***********************************************************************************************************************
*  OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
*  See also https://openstudio.net/license
***********************************************************************************************************************/

#include "Model.hpp"
#include "Model_Impl.hpp"

#include "PlantComponentUserDefined.hpp"
#include "PlantComponentUserDefined_Impl.hpp"

#include "EnergyManagementSystemProgramCallingManager.hpp"
#include "EnergyManagementSystemProgramCallingManager_Impl.hpp"
#include "EnergyManagementSystemProgram.hpp"
#include "EnergyManagementSystemProgram_Impl.hpp"
#include "EnergyManagementSystemActuator.hpp"
#include "EnergyManagementSystemActuator_Impl.hpp"
#include "Connection.hpp"
#include "Connection_Impl.hpp"
#include "Node.hpp"
#include "Node_Impl.hpp"
#include "ThermalZone.hpp"
#include "ThermalZone_Impl.hpp"

#include "../utilities/core/Assert.hpp"
#include "../utilities/data/DataEnums.hpp"

#include <utilities/idd/IddFactory.hxx>
#include <utilities/idd/IddEnums.hxx>
#include <utilities/idd/OS_PlantComponent_UserDefined_FieldEnums.hxx>

namespace openstudio {
namespace model {

  namespace detail {

    PlantComponentUserDefined_Impl::PlantComponentUserDefined_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle)
      : StraightComponent_Impl(idfObject, model, keepHandle) {
      OS_ASSERT(idfObject.iddObject().type() == PlantComponentUserDefined::iddObjectType());
    }

    PlantComponentUserDefined_Impl::PlantComponentUserDefined_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model,
                                                                   bool keepHandle)
      : StraightComponent_Impl(other, model, keepHandle) {
      OS_ASSERT(other.iddObject().type() == PlantComponentUserDefined::iddObjectType());
    }

    PlantComponentUserDefined_Impl::PlantComponentUserDefined_Impl(const PlantComponentUserDefined_Impl& other, Model_Impl* model, bool keepHandle)
      : StraightComponent_Impl(other, model, keepHandle) {}

    const std::vector<std::string>& PlantComponentUserDefined_Impl::outputVariableNames() const {
      static const std::vector<std::string> result;
      if (result.empty()) {
      }
      return result;
    }

    IddObjectType PlantComponentUserDefined_Impl::iddObjectType() const {
      return PlantComponentUserDefined::iddObjectType();
    }

    ModelObject PlantComponentUserDefined_Impl::clone(Model model) const {

      auto newPlantComponentUserDefined = ModelObject_Impl::clone(model).cast<PlantComponentUserDefined>();
      //designVolumeFlowRateActuator
      if (boost::optional<EnergyManagementSystemActuator> object = designVolumeFlowRateActuator()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemActuator>();
        //DO THIS HERE OR IN THE PlantComponentUserDefined_Impl::setDesignVolumeFlowRateActuator() method??
        objectClone.setActuatedComponent(newPlantComponentUserDefined);
        newPlantComponentUserDefined.setDesignVolumeFlowRateActuator(objectClone);
      }
      //minimumMassFlowRateActuator
      if (boost::optional<EnergyManagementSystemActuator> object = minimumMassFlowRateActuator()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemActuator>();
        objectClone.setActuatedComponent(newPlantComponentUserDefined);
        newPlantComponentUserDefined.setMinimumMassFlowRateActuator(objectClone);
      }
      //maximumMassFlowRateActuator
      if (boost::optional<EnergyManagementSystemActuator> object = maximumMassFlowRateActuator()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemActuator>();
        objectClone.setActuatedComponent(newPlantComponentUserDefined);
        newPlantComponentUserDefined.setMaximumMassFlowRateActuator(objectClone);
      }
      //minimumLoadingCapacityActuator
      if (boost::optional<EnergyManagementSystemActuator> object = minimumLoadingCapacityActuator()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemActuator>();
        objectClone.setActuatedComponent(newPlantComponentUserDefined);
        newPlantComponentUserDefined.setMinimumLoadingCapacityActuator(objectClone);
      }
      //maximumLoadingCapacityActuator
      if (boost::optional<EnergyManagementSystemActuator> object = maximumLoadingCapacityActuator()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemActuator>();
        objectClone.setActuatedComponent(newPlantComponentUserDefined);
        newPlantComponentUserDefined.setMaximumLoadingCapacityActuator(objectClone);
      }
      //optimalLoadingCapacityActuator
      if (boost::optional<EnergyManagementSystemActuator> object = optimalLoadingCapacityActuator()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemActuator>();
        objectClone.setActuatedComponent(newPlantComponentUserDefined);
        newPlantComponentUserDefined.setOptimalLoadingCapacityActuator(objectClone);
      }
      //outletTemperatureActuator
      if (boost::optional<EnergyManagementSystemActuator> object = outletTemperatureActuator()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemActuator>();
        objectClone.setActuatedComponent(newPlantComponentUserDefined);
        newPlantComponentUserDefined.setOutletTemperatureActuator(objectClone);
      }
      //massFlowRateActuator
      if (boost::optional<EnergyManagementSystemActuator> object = massFlowRateActuator()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemActuator>();
        objectClone.setActuatedComponent(newPlantComponentUserDefined);
        newPlantComponentUserDefined.setMassFlowRateActuator(objectClone);
      }
      //mainModelProgramCallingManager
      if (boost::optional<EnergyManagementSystemProgramCallingManager> object = mainModelProgramCallingManager()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemProgramCallingManager>();
        //clone the program referenced in the callingManager
        if (boost::optional<EnergyManagementSystemProgram> program = mainModelProgram()) {
          auto cloneProgram = program.get().clone(model).cast<EnergyManagementSystemProgram>();
          //add cloned program to cloned PCUD
          newPlantComponentUserDefined.setMainModelProgram(cloneProgram);
          //add cloned program to cloned programCallingManager
          objectClone.erasePrograms();
          objectClone.addProgram(cloneProgram);
        }
        newPlantComponentUserDefined.setMainModelProgramCallingManager(objectClone);
      }
      //plantInitializationProgramCallingManager
      if (boost::optional<EnergyManagementSystemProgramCallingManager> object = plantInitializationProgramCallingManager()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemProgramCallingManager>();
        boost::optional<EnergyManagementSystemActuator> dvfr = newPlantComponentUserDefined.designVolumeFlowRateActuator();
        boost::optional<EnergyManagementSystemActuator> mmfr = newPlantComponentUserDefined.minimumMassFlowRateActuator();
        boost::optional<EnergyManagementSystemActuator> mxfr = newPlantComponentUserDefined.maximumMassFlowRateActuator();
        boost::optional<EnergyManagementSystemActuator> mlc = newPlantComponentUserDefined.minimumLoadingCapacityActuator();
        boost::optional<EnergyManagementSystemActuator> mxlc = newPlantComponentUserDefined.maximumLoadingCapacityActuator();
        boost::optional<EnergyManagementSystemActuator> olc = newPlantComponentUserDefined.optimalLoadingCapacityActuator();

        //clone the program referenced in the callingManager
        EnergyManagementSystemProgram program =
          newPlantComponentUserDefined.createInitProgram(dvfr.get(), mmfr.get(), mxfr.get(), mlc.get(), mxlc.get(), olc.get(), model);

        newPlantComponentUserDefined.setPlantInitializationProgram(program);
        //add cloned program to cloned programCallingManager
        objectClone.erasePrograms();
        objectClone.addProgram(program);
        newPlantComponentUserDefined.setPlantInitializationProgramCallingManager(objectClone);
      }
      //plantSimulationProgramCallingManager
      if (boost::optional<EnergyManagementSystemProgramCallingManager> object = plantSimulationProgramCallingManager()) {
        auto objectClone = object.get().clone(model).cast<EnergyManagementSystemProgramCallingManager>();
        boost::optional<EnergyManagementSystemActuator> ot = newPlantComponentUserDefined.outletTemperatureActuator();
        boost::optional<EnergyManagementSystemActuator> mfr = newPlantComponentUserDefined.massFlowRateActuator();
        //clone the program referenced in the callingManager
        EnergyManagementSystemProgram program = newPlantComponentUserDefined.createSimProgram(ot.get(), mfr.get(), model);
        //add cloned program to cloned PCUD
        newPlantComponentUserDefined.setPlantSimulationProgram(program);
        //add cloned program to cloned programCallingManager
        objectClone.erasePrograms();
        objectClone.addProgram(program);

        newPlantComponentUserDefined.setPlantSimulationProgramCallingManager(objectClone);
      }
      //ambientZone
      if (boost::optional<ThermalZone> object = ambientZone()) {
        //ThermalZone objectClone = object.get().clone(model).cast<ThermalZone>();
        newPlantComponentUserDefined.setAmbientZone(object.get());
      }
      return std::move(newPlantComponentUserDefined);
    }

    std::vector<IddObjectType> PlantComponentUserDefined_Impl::allowableChildTypes() const {
      std::vector<IddObjectType> result;
      result.push_back(IddObjectType::OS_EnergyManagementSystem_ProgramCallingManager);
      result.push_back(IddObjectType::OS_EnergyManagementSystem_Program);
      result.push_back(IddObjectType::OS_EnergyManagementSystem_Actuator);
      result.push_back(IddObjectType::OS_PlantComponent_UserDefined);
      return result;
    }

    // Returns the children object
    std::vector<ModelObject> PlantComponentUserDefined_Impl::children() const {
      std::vector<ModelObject> result;
      if (boost::optional<EnergyManagementSystemProgramCallingManager> mpcm = mainModelProgramCallingManager()) {
        result.push_back(mpcm.get());
      }
      if (boost::optional<EnergyManagementSystemProgramCallingManager> ipcm = plantInitializationProgramCallingManager()) {
        result.push_back(ipcm.get());
      }
      if (boost::optional<EnergyManagementSystemProgramCallingManager> spcm = plantSimulationProgramCallingManager()) {
        result.push_back(spcm.get());
      }
      if (boost::optional<EnergyManagementSystemProgram> mp = mainModelProgram()) {
        result.push_back(mp.get());
      }
      if (boost::optional<EnergyManagementSystemProgram> ip = plantInitializationProgram()) {
        result.push_back(ip.get());
      }
      if (boost::optional<EnergyManagementSystemProgram> sp = plantSimulationProgram()) {
        result.push_back(sp.get());
      }
      if (boost::optional<EnergyManagementSystemActuator> dvfr = designVolumeFlowRateActuator()) {
        result.push_back(dvfr.get());
      }
      if (boost::optional<EnergyManagementSystemActuator> mmfr = minimumMassFlowRateActuator()) {
        result.push_back(mmfr.get());
      }
      if (boost::optional<EnergyManagementSystemActuator> mxfr = maximumMassFlowRateActuator()) {
        result.push_back(mxfr.get());
      }
      if (boost::optional<EnergyManagementSystemActuator> mlc = minimumLoadingCapacityActuator()) {
        result.push_back(mlc.get());
      }
      if (boost::optional<EnergyManagementSystemActuator> mxlc = maximumLoadingCapacityActuator()) {
        result.push_back(mxlc.get());
      }
      if (boost::optional<EnergyManagementSystemActuator> olc = optimalLoadingCapacityActuator()) {
        result.push_back(olc.get());
      }
      if (boost::optional<EnergyManagementSystemActuator> ot = outletTemperatureActuator()) {
        result.push_back(ot.get());
      }
      if (boost::optional<EnergyManagementSystemActuator> mfr = massFlowRateActuator()) {
        result.push_back(mfr.get());
      }
      return result;
    }

    std::string PlantComponentUserDefined_Impl::plantLoadingMode() const {
      boost::optional<std::string> value = getString(OS_PlantComponent_UserDefinedFields::PlantLoadingMode, true);
      OS_ASSERT(value);
      return value.get();
    }

    std::string PlantComponentUserDefined_Impl::plantLoopFlowRequestMode() const {
      boost::optional<std::string> value = getString(OS_PlantComponent_UserDefinedFields::PlantLoopFlowRequestMode, true);
      OS_ASSERT(value);
      return value.get();
    }

    boost::optional<EnergyManagementSystemProgramCallingManager> PlantComponentUserDefined_Impl::mainModelProgramCallingManager() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemProgramCallingManager>(
        OS_PlantComponent_UserDefinedFields::MainModelProgramCallingManagerName);
    }

    boost::optional<EnergyManagementSystemProgramCallingManager> PlantComponentUserDefined_Impl::plantInitializationProgramCallingManager() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemProgramCallingManager>(
        OS_PlantComponent_UserDefinedFields::PlantInitializationProgramCallingManagerName);
    }

    boost::optional<EnergyManagementSystemProgramCallingManager> PlantComponentUserDefined_Impl::plantSimulationProgramCallingManager() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemProgramCallingManager>(
        OS_PlantComponent_UserDefinedFields::PlantSimulationProgramCallingManagerName);
    }

    boost::optional<EnergyManagementSystemProgram> PlantComponentUserDefined_Impl::mainModelProgram() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemProgram>(OS_PlantComponent_UserDefinedFields::MainModelProgramName);
    }

    boost::optional<EnergyManagementSystemProgram> PlantComponentUserDefined_Impl::plantInitializationProgram() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemProgram>(
        OS_PlantComponent_UserDefinedFields::PlantInitializationProgramName);
    }

    boost::optional<EnergyManagementSystemProgram> PlantComponentUserDefined_Impl::plantSimulationProgram() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemProgram>(
        OS_PlantComponent_UserDefinedFields::PlantSimulationProgramName);
    }

    boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined_Impl::designVolumeFlowRateActuator() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemActuator>(
        OS_PlantComponent_UserDefinedFields::DesignVolumeFlowRateActuator);
    }

    boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined_Impl::minimumMassFlowRateActuator() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemActuator>(
        OS_PlantComponent_UserDefinedFields::MinimumMassFlowRateActuator);
    }

    boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined_Impl::maximumMassFlowRateActuator() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemActuator>(
        OS_PlantComponent_UserDefinedFields::MaximumMassFlowRateActuator);
    }

    boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined_Impl::minimumLoadingCapacityActuator() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemActuator>(
        OS_PlantComponent_UserDefinedFields::MinimumLoadingCapacityActuator);
    }

    boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined_Impl::maximumLoadingCapacityActuator() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemActuator>(
        OS_PlantComponent_UserDefinedFields::MaximumLoadingCapacityActuator);
    }

    boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined_Impl::optimalLoadingCapacityActuator() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemActuator>(
        OS_PlantComponent_UserDefinedFields::OptimalLoadingCapacityActuator);
    }

    boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined_Impl::outletTemperatureActuator() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemActuator>(
        OS_PlantComponent_UserDefinedFields::OutletTemperatureActuator);
    }

    boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined_Impl::massFlowRateActuator() const {
      return getObject<ModelObject>().getModelObjectTarget<EnergyManagementSystemActuator>(OS_PlantComponent_UserDefinedFields::MassFlowRateActuator);
    }

    boost::optional<ThermalZone> PlantComponentUserDefined_Impl::ambientZone() const {
      return getObject<ModelObject>().getModelObjectTarget<ThermalZone>(OS_PlantComponent_UserDefinedFields::AmbientZoneName);
    }

    bool PlantComponentUserDefined_Impl::setPlantLoadingMode(const std::string& plantLoadingMode) {
      bool result = setString(OS_PlantComponent_UserDefinedFields::PlantLoadingMode, plantLoadingMode);
      return result;
    }

    bool PlantComponentUserDefined_Impl::setPlantLoopFlowRequestMode(const std::string& plantLoopFlowRequestMode) {
      bool result = setString(OS_PlantComponent_UserDefinedFields::PlantLoopFlowRequestMode, plantLoopFlowRequestMode);
      return result;
    }

    bool PlantComponentUserDefined_Impl::setMainModelProgramCallingManager(
      const EnergyManagementSystemProgramCallingManager& energyManagementSystemProgramCallingManager) {
      bool result =
        setPointer(OS_PlantComponent_UserDefinedFields::MainModelProgramCallingManagerName, energyManagementSystemProgramCallingManager.handle());
      return result;
    }

    void PlantComponentUserDefined_Impl::resetMainModelProgramCallingManager() {
      bool result = setString(OS_PlantComponent_UserDefinedFields::MainModelProgramCallingManagerName, "");
      OS_ASSERT(result);
    }

    bool PlantComponentUserDefined_Impl::setPlantInitializationProgramCallingManager(
      const EnergyManagementSystemProgramCallingManager& energyManagementSystemProgramCallingManager) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::PlantInitializationProgramCallingManagerName,
                               energyManagementSystemProgramCallingManager.handle());
      return result;
    }

    void PlantComponentUserDefined_Impl::resetPlantInitializationProgramCallingManager() {
      bool result = setString(OS_PlantComponent_UserDefinedFields::PlantInitializationProgramCallingManagerName, "");
      OS_ASSERT(result);
    }

    bool PlantComponentUserDefined_Impl::setPlantSimulationProgramCallingManager(
      const EnergyManagementSystemProgramCallingManager& energyManagementSystemProgramCallingManager) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::PlantSimulationProgramCallingManagerName,
                               energyManagementSystemProgramCallingManager.handle());
      return result;
    }

    void PlantComponentUserDefined_Impl::resetPlantSimulationProgramCallingManager() {
      bool result = setString(OS_PlantComponent_UserDefinedFields::PlantSimulationProgramCallingManagerName, "");
      OS_ASSERT(result);
    }

    bool PlantComponentUserDefined_Impl::setMainModelProgram(const EnergyManagementSystemProgram& energyManagementSystemProgram) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::MainModelProgramName, energyManagementSystemProgram.handle());
      return result;
    }

    void PlantComponentUserDefined_Impl::resetMainModelProgram() {
      bool result = setString(OS_PlantComponent_UserDefinedFields::MainModelProgramName, "");
      OS_ASSERT(result);
    }

    bool PlantComponentUserDefined_Impl::setPlantInitializationProgram(const EnergyManagementSystemProgram& energyManagementSystemProgram) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::PlantInitializationProgramName, energyManagementSystemProgram.handle());
      return result;
    }

    void PlantComponentUserDefined_Impl::resetPlantInitializationProgram() {
      bool result = setString(OS_PlantComponent_UserDefinedFields::PlantInitializationProgramName, "");
      OS_ASSERT(result);
    }

    bool PlantComponentUserDefined_Impl::setPlantSimulationProgram(const EnergyManagementSystemProgram& energyManagementSystemProgram) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::PlantSimulationProgramName, energyManagementSystemProgram.handle());
      return result;
    }

    void PlantComponentUserDefined_Impl::resetPlantSimulationProgram() {
      bool result = setString(OS_PlantComponent_UserDefinedFields::PlantSimulationProgramName, "");
      OS_ASSERT(result);
    }

    bool PlantComponentUserDefined_Impl::setAmbientZone(const ThermalZone& thermalZone) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::AmbientZoneName, thermalZone.handle());
      return result;
    }

    void PlantComponentUserDefined_Impl::resetAmbientZone() {
      bool result = setString(OS_PlantComponent_UserDefinedFields::AmbientZoneName, "");
      OS_ASSERT(result);
    }

    unsigned PlantComponentUserDefined_Impl::inletPort() const {
      return OS_PlantComponent_UserDefinedFields::PlantInletNodeName;
    }

    unsigned PlantComponentUserDefined_Impl::outletPort() const {
      return OS_PlantComponent_UserDefinedFields::PlantOutletNodeName;
    }

    bool PlantComponentUserDefined_Impl::addToNode(Node& node) {
      if (boost::optional<PlantLoop> plant = node.plantLoop()) {
        //allow PlantComponentUserDefined object on demand side as well
        //if (plant->supplyComponent(node.handle())) {
        return StraightComponent_Impl::addToNode(node);
        //}
      }
      return false;
    }

    bool PlantComponentUserDefined_Impl::setDesignVolumeFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::DesignVolumeFlowRateActuator, energyManagementSystemActuator.handle());
      return result;
    }

    bool PlantComponentUserDefined_Impl::setMinimumMassFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::MinimumMassFlowRateActuator, energyManagementSystemActuator.handle());
      return result;
    }

    bool PlantComponentUserDefined_Impl::setMaximumMassFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::MaximumMassFlowRateActuator, energyManagementSystemActuator.handle());
      return result;
    }

    bool PlantComponentUserDefined_Impl::setMinimumLoadingCapacityActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::MinimumLoadingCapacityActuator, energyManagementSystemActuator.handle());
      return result;
    }

    bool PlantComponentUserDefined_Impl::setMaximumLoadingCapacityActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::MaximumLoadingCapacityActuator, energyManagementSystemActuator.handle());
      return result;
    }

    bool PlantComponentUserDefined_Impl::setOptimalLoadingCapacityActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::OptimalLoadingCapacityActuator, energyManagementSystemActuator.handle());
      return result;
    }

    bool PlantComponentUserDefined_Impl::setOutletTemperatureActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::OutletTemperatureActuator, energyManagementSystemActuator.handle());
      return result;
    }

    bool PlantComponentUserDefined_Impl::setMassFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
      bool result = setPointer(OS_PlantComponent_UserDefinedFields::MassFlowRateActuator, energyManagementSystemActuator.handle());
      return result;
    }

    EnergyManagementSystemProgram PlantComponentUserDefined_Impl::createInitProgram(
      const EnergyManagementSystemActuator& dvfrActuator, const EnergyManagementSystemActuator& mmfrActuator,
      const EnergyManagementSystemActuator& mxfrActuator, const EnergyManagementSystemActuator& mlcActuator,
      const EnergyManagementSystemActuator& mxlcActuator, const EnergyManagementSystemActuator& olcActuator, const Model& model) {
      std::string line;
      EnergyManagementSystemProgram initProgram(model);
      initProgram.setName("PCUD_InitProgram");
      line = "   SET LoopExitTemp = 82.22, !- <none> \r\n";
      initProgram.addLine(line);
      line = "   SET LoopDeltaTemp = 4.0, !- <none> \r\n";
      initProgram.addLine(line);
      line = "   SET CP = @CPCW LoopExitTemp, !- <none> \r\n";
      initProgram.addLine(line);
      line = "   SET rho = @RhoH2O LoopExitTemp, !- <none> \r\n";
      initProgram.addLine(line);
      line = "   SET " + toString(dvfrActuator.handle()) + " = 0.5, !- <none> \r\n";
      initProgram.addLine(line);
      line = "   SET " + toString(mmfrActuator.handle()) + " = 0.0, !- <none> \r\n";
      initProgram.addLine(line);
      line = "   SET " + toString(mxfrActuator.handle()) + " = " + toString(dvfrActuator.handle()) + " * rho, !- <none> \r\n";
      initProgram.addLine(line);
      line = "   SET PCUD_Cap = CP * rho * LoopDeltaTemp * 0.5, !- <none> \r\n";
      initProgram.addLine(line);
      line = "   SET " + toString(mlcActuator.handle()) + " = 0.0, !- <none> \r\n";
      initProgram.addLine(line);
      line = "   SET " + toString(mxlcActuator.handle()) + " = PCUD_Cap, !- <none> \r\n";
      initProgram.addLine(line);
      line = "   SET " + toString(olcActuator.handle()) + " = 0.9 * PCUD_Cap, !- <none> \r\n";
      initProgram.addLine(line);
      return initProgram;
    }

    EnergyManagementSystemProgram PlantComponentUserDefined_Impl::createSimProgram(const EnergyManagementSystemActuator& otActuator,
                                                                                   const EnergyManagementSystemActuator& mfrActuator,
                                                                                   const Model& model) {
      EnergyManagementSystemProgram simProgram(model);
      std::string line;
      simProgram.setName("PCUD_SimProgram");
      line = "   SET " + toString(otActuator.handle()) + " = 82.22, !- <none> \r\n";
      simProgram.addLine(line);
      line = "   SET " + toString(mfrActuator.handle()) + " = 0.5, !- <none> \r\n";
      simProgram.addLine(line);
      return simProgram;
    }

    ComponentType PlantComponentUserDefined_Impl::componentType() const {
      return ComponentType::Both;
    }

    std::vector<FuelType> PlantComponentUserDefined_Impl::coolingFuelTypes() const {
      return {FuelType::OtherFuel_1};
    }

    std::vector<FuelType> PlantComponentUserDefined_Impl::heatingFuelTypes() const {
      return {FuelType::OtherFuel_1};
    }

    std::vector<AppGFuelType> PlantComponentUserDefined_Impl::appGHeatingFuelTypes() const {
      return {AppGFuelType::Other};
    }

  }  // namespace detail

  PlantComponentUserDefined::PlantComponentUserDefined(const Model& model) : StraightComponent(PlantComponentUserDefined::iddObjectType(), model) {
    OS_ASSERT(getImpl<detail::PlantComponentUserDefined_Impl>());

    bool ok = true;
    ok = setPlantLoadingMode("MeetsLoadWithNominalCapacityHiOutLimit");
    OS_ASSERT(ok);
    ok = setPlantLoopFlowRequestMode("NeedsFlowIfLoopOn");
    OS_ASSERT(ok);
    //setup required Actuators for Plant Connection 1
    EnergyManagementSystemActuator dvfrActuator(this->cast<ModelObject>(), "Plant Connection 1", "Design Volume Flow Rate");
    dvfrActuator.setName("PCUD_Vdot_Design");
    ok = setDesignVolumeFlowRateActuator(dvfrActuator);
    OS_ASSERT(ok);
    EnergyManagementSystemActuator mmfrActuator(this->cast<ModelObject>(), "Plant Connection 1", "Minimum Mass Flow Rate");
    mmfrActuator.setName("PCUD_Mdot_Min");
    ok = setMinimumMassFlowRateActuator(mmfrActuator);
    OS_ASSERT(ok);
    EnergyManagementSystemActuator mxfrActuator(this->cast<ModelObject>(), "Plant Connection 1", "Maximum Mass Flow Rate");
    mxfrActuator.setName("PCUD_Mdot_Max");
    ok = setMaximumMassFlowRateActuator(mxfrActuator);
    OS_ASSERT(ok);
    EnergyManagementSystemActuator mlcActuator(this->cast<ModelObject>(), "Plant Connection 1", "Minimum Loading Capacity");
    mlcActuator.setName("PCUD_Cap_Min");
    ok = setMinimumLoadingCapacityActuator(mlcActuator);
    OS_ASSERT(ok);
    EnergyManagementSystemActuator mxlcActuator(this->cast<ModelObject>(), "Plant Connection 1", "Maximum Loading Capacity");
    mxlcActuator.setName("PCUD_Cap_Max");
    ok = setMaximumLoadingCapacityActuator(mxlcActuator);
    OS_ASSERT(ok);
    EnergyManagementSystemActuator olcActuator(this->cast<ModelObject>(), "Plant Connection 1", "Optimal Loading Capacity");
    olcActuator.setName("PCUD_Cap_Opt");
    ok = setOptimalLoadingCapacityActuator(olcActuator);
    OS_ASSERT(ok);
    EnergyManagementSystemActuator otActuator(this->cast<ModelObject>(), "Plant Connection 1", "Outlet Temperature");
    otActuator.setName("PCUD_Tout");
    ok = setOutletTemperatureActuator(otActuator);
    OS_ASSERT(ok);
    EnergyManagementSystemActuator mfrActuator(this->cast<ModelObject>(), "Plant Connection 1", "Mass Flow Rate");
    mfrActuator.setName("PCUD_Mdot_Request");
    ok = setMassFlowRateActuator(mfrActuator);
    OS_ASSERT(ok);

    //setup Main Program and Manager
    /*
  EnergyManagementSystemProgram mainProgram(model);
  mainProgram.setName("PCUD_MainProgram");

  EnergyManagementSystemProgramCallingManager mainProgramCallingManager(model);
  mainProgramCallingManager.setName("PCUD_MainProgramCallingManager");
  mainProgramCallingManager.setCallingPoint("UserDefinedComponentModel");
  mainProgramCallingManager.addProgram(mainProgram);
  */
    //setup Init Program and Manager
    std::string line;
    EnergyManagementSystemProgram initProgram =
      createInitProgram(dvfrActuator, mmfrActuator, mxfrActuator, mlcActuator, mxlcActuator, olcActuator, model);

    EnergyManagementSystemProgramCallingManager initProgramCallingManager(model);
    initProgramCallingManager.setName("PCUD_InitProgramCallingManager");
    initProgramCallingManager.setCallingPoint("UserDefinedComponentModel");
    initProgramCallingManager.addProgram(initProgram);
    //add as children so they delete if object gets removed
    ok = setPlantInitializationProgramCallingManager(initProgramCallingManager);
    OS_ASSERT(ok);
    ok = setPlantInitializationProgram(initProgram);
    OS_ASSERT(ok);

    //setup Sim Program and Manager
    EnergyManagementSystemProgram simProgram = createSimProgram(otActuator, mfrActuator, model);
    EnergyManagementSystemProgramCallingManager simProgramCallingManager(model);
    simProgramCallingManager.setName("PCUD_SimProgramCallingManager");
    simProgramCallingManager.setCallingPoint("UserDefinedComponentModel");
    simProgramCallingManager.addProgram(simProgram);
    //add as children so they delete if object gets removed
    ok = setPlantSimulationProgramCallingManager(simProgramCallingManager);
    OS_ASSERT(ok);
    ok = setPlantSimulationProgram(simProgram);
    OS_ASSERT(ok);
  }

  IddObjectType PlantComponentUserDefined::iddObjectType() {
    return {IddObjectType::OS_PlantComponent_UserDefined};
  }

  std::vector<std::string> PlantComponentUserDefined::plantLoadingModeValues() {
    return getIddKeyNames(IddFactory::instance().getObject(iddObjectType()).get(), OS_PlantComponent_UserDefinedFields::PlantLoadingMode);
  }

  std::vector<std::string> PlantComponentUserDefined::plantLoopFlowRequestModeValues() {
    return getIddKeyNames(IddFactory::instance().getObject(iddObjectType()).get(), OS_PlantComponent_UserDefinedFields::PlantLoopFlowRequestMode);
  }

  std::string PlantComponentUserDefined::plantLoadingMode() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->plantLoadingMode();
  }

  std::string PlantComponentUserDefined::plantLoopFlowRequestMode() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->plantLoopFlowRequestMode();
  }

  boost::optional<EnergyManagementSystemProgramCallingManager> PlantComponentUserDefined::mainModelProgramCallingManager() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->mainModelProgramCallingManager();
  }

  boost::optional<EnergyManagementSystemProgramCallingManager> PlantComponentUserDefined::plantInitializationProgramCallingManager() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->plantInitializationProgramCallingManager();
  }

  boost::optional<EnergyManagementSystemProgramCallingManager> PlantComponentUserDefined::plantSimulationProgramCallingManager() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->plantSimulationProgramCallingManager();
  }

  boost::optional<EnergyManagementSystemProgram> PlantComponentUserDefined::mainModelProgram() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->mainModelProgram();
  }

  boost::optional<EnergyManagementSystemProgram> PlantComponentUserDefined::plantInitializationProgram() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->plantInitializationProgram();
  }

  boost::optional<EnergyManagementSystemProgram> PlantComponentUserDefined::plantSimulationProgram() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->plantSimulationProgram();
  }

  boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined::designVolumeFlowRateActuator() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->designVolumeFlowRateActuator();
  }

  boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined::minimumMassFlowRateActuator() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->minimumMassFlowRateActuator();
  }

  boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined::maximumMassFlowRateActuator() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->maximumMassFlowRateActuator();
  }

  boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined::minimumLoadingCapacityActuator() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->minimumLoadingCapacityActuator();
  }

  boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined::maximumLoadingCapacityActuator() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->maximumLoadingCapacityActuator();
  }

  boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined::optimalLoadingCapacityActuator() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->optimalLoadingCapacityActuator();
  }

  boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined::outletTemperatureActuator() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->outletTemperatureActuator();
  }

  boost::optional<EnergyManagementSystemActuator> PlantComponentUserDefined::massFlowRateActuator() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->massFlowRateActuator();
  }

  boost::optional<ThermalZone> PlantComponentUserDefined::ambientZone() const {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->ambientZone();
  }

  bool PlantComponentUserDefined::setPlantLoadingMode(const std::string& plantConnection1LoadingMode) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setPlantLoadingMode(plantConnection1LoadingMode);
  }

  bool PlantComponentUserDefined::setPlantLoopFlowRequestMode(const std::string& plantConnection1LoopFlowRequestMode) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setPlantLoopFlowRequestMode(plantConnection1LoopFlowRequestMode);
  }

  bool PlantComponentUserDefined::setMainModelProgramCallingManager(
    const EnergyManagementSystemProgramCallingManager& energyManagementSystemProgramCallingManager) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setMainModelProgramCallingManager(energyManagementSystemProgramCallingManager);
  }

  void PlantComponentUserDefined::resetMainModelProgramCallingManager() {
    getImpl<detail::PlantComponentUserDefined_Impl>()->resetMainModelProgramCallingManager();
  }

  bool PlantComponentUserDefined::setPlantInitializationProgramCallingManager(
    const EnergyManagementSystemProgramCallingManager& energyManagementSystemProgramCallingManager) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setPlantInitializationProgramCallingManager(
      energyManagementSystemProgramCallingManager);
  }

  void PlantComponentUserDefined::resetPlantInitializationProgramCallingManager() {
    getImpl<detail::PlantComponentUserDefined_Impl>()->resetPlantInitializationProgramCallingManager();
  }

  bool PlantComponentUserDefined::setPlantSimulationProgramCallingManager(
    const EnergyManagementSystemProgramCallingManager& energyManagementSystemProgramCallingManager) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setPlantSimulationProgramCallingManager(energyManagementSystemProgramCallingManager);
  }

  void PlantComponentUserDefined::resetPlantSimulationProgramCallingManager() {
    getImpl<detail::PlantComponentUserDefined_Impl>()->resetPlantSimulationProgramCallingManager();
  }

  bool PlantComponentUserDefined::setMainModelProgram(const EnergyManagementSystemProgram& energyManagementSystemProgram) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setMainModelProgram(energyManagementSystemProgram);
  }

  void PlantComponentUserDefined::resetMainModelProgram() {
    getImpl<detail::PlantComponentUserDefined_Impl>()->resetMainModelProgram();
  }

  bool PlantComponentUserDefined::setPlantInitializationProgram(const EnergyManagementSystemProgram& energyManagementSystemProgram) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setPlantInitializationProgram(energyManagementSystemProgram);
  }

  void PlantComponentUserDefined::resetPlantInitializationProgram() {
    getImpl<detail::PlantComponentUserDefined_Impl>()->resetPlantInitializationProgram();
  }

  bool PlantComponentUserDefined::setPlantSimulationProgram(const EnergyManagementSystemProgram& energyManagementSystemProgram) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setPlantSimulationProgram(energyManagementSystemProgram);
  }

  void PlantComponentUserDefined::resetPlantSimulationProgram() {
    getImpl<detail::PlantComponentUserDefined_Impl>()->resetPlantSimulationProgram();
  }

  bool PlantComponentUserDefined::setAmbientZone(const ThermalZone& thermalZone) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setAmbientZone(thermalZone);
  }

  void PlantComponentUserDefined::resetAmbientZone() {
    getImpl<detail::PlantComponentUserDefined_Impl>()->resetAmbientZone();
  }

  bool PlantComponentUserDefined::setDesignVolumeFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setDesignVolumeFlowRateActuator(energyManagementSystemActuator);
  }

  bool PlantComponentUserDefined::setMinimumMassFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setMinimumMassFlowRateActuator(energyManagementSystemActuator);
  }

  bool PlantComponentUserDefined::setMaximumMassFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setMaximumMassFlowRateActuator(energyManagementSystemActuator);
  }

  bool PlantComponentUserDefined::setMinimumLoadingCapacityActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setMinimumLoadingCapacityActuator(energyManagementSystemActuator);
  }

  bool PlantComponentUserDefined::setMaximumLoadingCapacityActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setMaximumLoadingCapacityActuator(energyManagementSystemActuator);
  }

  bool PlantComponentUserDefined::setOptimalLoadingCapacityActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setOptimalLoadingCapacityActuator(energyManagementSystemActuator);
  }

  bool PlantComponentUserDefined::setOutletTemperatureActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setOutletTemperatureActuator(energyManagementSystemActuator);
  }

  bool PlantComponentUserDefined::setMassFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->setMassFlowRateActuator(energyManagementSystemActuator);
  }

  EnergyManagementSystemProgram PlantComponentUserDefined::createInitProgram(const EnergyManagementSystemActuator& dvfrActuator,
                                                                             const EnergyManagementSystemActuator& mmfrActuator,
                                                                             const EnergyManagementSystemActuator& mxfrActuator,
                                                                             const EnergyManagementSystemActuator& mlcActuator,
                                                                             const EnergyManagementSystemActuator& mxlcActuator,
                                                                             const EnergyManagementSystemActuator& olcActuator, const Model& model) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->createInitProgram(dvfrActuator, mmfrActuator, mxfrActuator, mlcActuator, mxlcActuator,
                                                                                olcActuator, model);
  }

  EnergyManagementSystemProgram PlantComponentUserDefined::createSimProgram(const EnergyManagementSystemActuator& otActuator,
                                                                            const EnergyManagementSystemActuator& mfrActuator, const Model& model) {
    return getImpl<detail::PlantComponentUserDefined_Impl>()->createSimProgram(otActuator, mfrActuator, model);
  }

  /// @cond
  PlantComponentUserDefined::PlantComponentUserDefined(std::shared_ptr<detail::PlantComponentUserDefined_Impl> impl) : StraightComponent(impl) {}
  /// @endcond

}  // namespace model
}  // namespace openstudio