text: /***********************************************************************************************************************
  *  OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
  *
  *  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
  *  following conditions are met:
  *
  *  (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
  *  disclaimer.
  *
  *  (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
  *  disclaimer in the documentation and/or other materials provided with the distribution.
  *
  *  (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote products
  *  derived from this software without specific prior written permission from the respective party.
  *
  *  (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other derivative works
  *  may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar designation without specific prior
  *  written permission from Alliance for Sustainable Energy, LLC.
  *
  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED
  *  STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  *  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  *  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  *  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  ***********************************************************************************************************************/
  
  #ifndef MODEL_OTHEREQUIPMENT_IMPL_HPP
  #define MODEL_OTHEREQUIPMENT_IMPL_HPP
  
  #include "ModelAPI.hpp"
  #include "SpaceLoadInstance_Impl.hpp"
  
  namespace openstudio {
  namespace model {
  
  class OtherEquipmentDefinition;
  class Schedule;
  
  namespace detail {
  
    /** OtherEquipment_Impl is a SpaceLoadInstance_Impl that is the implementation class for OtherEquipment.*/
    class MODEL_API OtherEquipment_Impl : public SpaceLoadInstance_Impl {
     public:
  
      /** @name Constructors and Destructors */
      //@{
  
      OtherEquipment_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle);
  
      OtherEquipment_Impl(const openstudio::detail::WorkspaceObject_Impl& other,
                          Model_Impl* model,
                          bool keepHandle);
  
      OtherEquipment_Impl(const OtherEquipment_Impl& other,
                          Model_Impl* model,
                          bool keepHandle);
  
      virtual ~OtherEquipment_Impl() {}
  
      //@}
      /** @name Virtual Methods */
      //@{
  
      virtual const std::vector<std::string>& outputVariableNames() const override;
  
      virtual IddObjectType iddObjectType() const override;
  
      virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override;
  
      virtual bool hardSize() override;
  
      virtual bool hardApplySchedules() override;
  
      virtual double multiplier() const override;
  
      virtual bool isMultiplierDefaulted() const override;
  
      virtual bool isAbsolute() const override;
  
      //@}
      /** @name Getters */
      //@{
  
      std::string endUseSubcategory() const;
  
      bool isEndUseSubcategoryDefaulted() const;
  
      std::string fuelType() const;
  
      bool isFuelTypeDefaulted() const;
  
      OtherEquipmentDefinition otherEquipmentDefinition() const;
  
      /** Returns the (fractional) equipment schedule.  If this object does not
       *  specify a schedule this function will search the hierarchy. */
      boost::optional<Schedule> schedule() const;
  
      /** Returns true if this object does not specify a schedule directly. */
      bool isScheduleDefaulted() const;
  
      //@}
      /** @name Setters */
      //@{
  
      bool setEndUseSubcategory(const std::string& endUseSubcategory);
  
      void resetEndUseSubcategory();
  
      bool setFuelType(const std::string& fuelType);
  
      void resetFuelType();
  
      bool setOtherEquipmentDefinition(const OtherEquipmentDefinition& definition);
  
      virtual bool setDefinition(const SpaceLoadDefinition& definition) override;
  
      /** Sets the (fractional) Schedule. */
      bool setSchedule(Schedule& schedule);
  
      /** Resets the (fractional) Schedule. */
      void resetSchedule();
  
      bool setMultiplier(double multiplier);
  
      void resetMultiplier();
  
      //@}
      /** @name Other */
      //@{
  
      /** Returns the design level represented by this instance, assuming floorArea (m^2) and
       *  numPeople. */
      double getDesignLevel(double floorArea, double numPeople) const;
  
      /** Returns the watts/m^2 represented by this instance, assuming floorArea (m^2) and
       *  numPeople. */
      double getPowerPerFloorArea(double floorArea, double numPeople) const;
  
      /** Returns the watts/person represented by this instance, assuming floorArea (m^2) and
       *  numPeople. */
      double getPowerPerPerson(double floorArea, double numPeople) const;
  
      virtual std::vector<EMSActuatorNames> emsActuatorNames() const override;
  
      virtual std::vector<std::string> emsInternalVariableNames() const override;
  
      //@}
     protected:
  
      // index of the space name
      virtual int spaceIndex() const override;
  
      // index of the definition name
      virtual int definitionIndex() const override;
  
     private:
      REGISTER_LOGGER("openstudio.model.OtherEquipment");
  
      boost::optional<ModelObject> otherEquipmentDefinitionAsModelObject() const;
      boost::optional<ModelObject> scheduleAsModelObject() const;
  
      bool setOtherEquipmentDefinitionAsModelObject(const boost::optional<ModelObject>& modelObject);
      bool setScheduleAsModelObject(const boost::optional<ModelObject>& modelObject);
    };
  
  } // detail
  
  } // model
  } // openstudio
  
  #endif // MODEL_OTHEREQUIPMENT_IMPL_HPP
  
  