OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::PlantComponentUserDefined Class Reference

#include <PlantComponentUserDefined.hpp>

+ Inheritance diagram for openstudio::model::PlantComponentUserDefined:

Public Member Functions

Constructors and Destructors
 PlantComponentUserDefined (const Model &model)
 
virtual ~PlantComponentUserDefined ()=default
 
 PlantComponentUserDefined (const PlantComponentUserDefined &other)=default
 
 PlantComponentUserDefined (PlantComponentUserDefined &&other)=default
 
PlantComponentUserDefinedoperator= (const PlantComponentUserDefined &)=default
 
PlantComponentUserDefinedoperator= (PlantComponentUserDefined &&)=default
 
Getters
std::string plantLoadingMode () const
 
std::string plantLoopFlowRequestMode () const
 
boost::optional
< EnergyManagementSystemProgramCallingManager
mainModelProgramCallingManager () const
 
boost::optional
< EnergyManagementSystemProgramCallingManager
plantInitializationProgramCallingManager () const
 
boost::optional
< EnergyManagementSystemProgramCallingManager
plantSimulationProgramCallingManager () const
 
boost::optional
< EnergyManagementSystemProgram
mainModelProgram () const
 
boost::optional
< EnergyManagementSystemProgram
plantInitializationProgram () const
 
boost::optional
< EnergyManagementSystemProgram
plantSimulationProgram () const
 
boost::optional< ThermalZoneambientZone () const
 
boost::optional
< EnergyManagementSystemActuator
designVolumeFlowRateActuator () const
 
boost::optional
< EnergyManagementSystemActuator
minimumMassFlowRateActuator () const
 
boost::optional
< EnergyManagementSystemActuator
maximumMassFlowRateActuator () const
 
boost::optional
< EnergyManagementSystemActuator
minimumLoadingCapacityActuator () const
 
boost::optional
< EnergyManagementSystemActuator
maximumLoadingCapacityActuator () const
 
boost::optional
< EnergyManagementSystemActuator
optimalLoadingCapacityActuator () const
 
boost::optional
< EnergyManagementSystemActuator
outletTemperatureActuator () const
 
boost::optional
< EnergyManagementSystemActuator
massFlowRateActuator () const
 
Setters
bool setPlantLoadingMode (const std::string &plantLoadingMode)
 
bool setPlantLoopFlowRequestMode (const std::string &plantLoopFlowRequestMode)
 
bool setMainModelProgramCallingManager (const EnergyManagementSystemProgramCallingManager &energyManagementSystemProgramCallingManager)
 
void resetMainModelProgramCallingManager ()
 
bool setPlantInitializationProgramCallingManager (const EnergyManagementSystemProgramCallingManager &energyManagementSystemProgramCallingManager)
 
void resetPlantInitializationProgramCallingManager ()
 
bool setPlantSimulationProgramCallingManager (const EnergyManagementSystemProgramCallingManager &energyManagementSystemProgramCallingManager)
 
void resetPlantSimulationProgramCallingManager ()
 
bool setMainModelProgram (const EnergyManagementSystemProgram &energyManagementSystemProgram)
 
void resetMainModelProgram ()
 
bool setPlantInitializationProgram (const EnergyManagementSystemProgram &energyManagementSystemProgram)
 
void resetPlantInitializationProgram ()
 
bool setPlantSimulationProgram (const EnergyManagementSystemProgram &energyManagementSystemProgram)
 
void resetPlantSimulationProgram ()
 
bool setAmbientZone (const ThermalZone &thermalZone)
 
void resetAmbientZone ()
 
bool setDesignVolumeFlowRateActuator (const EnergyManagementSystemActuator &energyManagementSystemActuator)
 
bool setMinimumMassFlowRateActuator (const EnergyManagementSystemActuator &energyManagementSystemActuator)
 
bool setMaximumMassFlowRateActuator (const EnergyManagementSystemActuator &energyManagementSystemActuator)
 
bool setMinimumLoadingCapacityActuator (const EnergyManagementSystemActuator &energyManagementSystemActuator)
 
bool setMaximumLoadingCapacityActuator (const EnergyManagementSystemActuator &energyManagementSystemActuator)
 
bool setOptimalLoadingCapacityActuator (const EnergyManagementSystemActuator &energyManagementSystemActuator)
 
bool setOutletTemperatureActuator (const EnergyManagementSystemActuator &energyManagementSystemActuator)
 
bool setMassFlowRateActuator (const EnergyManagementSystemActuator &energyManagementSystemActuator)
 
EnergyManagementSystemProgram createInitProgram (const EnergyManagementSystemActuator &dvfrActuator, const EnergyManagementSystemActuator &mmfrActuator, const EnergyManagementSystemActuator &mxfrActuator, const EnergyManagementSystemActuator &mlcActuator, const EnergyManagementSystemActuator &mxlcActuator, const EnergyManagementSystemActuator &olcActuator, const Model &model)
 
EnergyManagementSystemProgram createSimProgram (const EnergyManagementSystemActuator &otActuator, const EnergyManagementSystemActuator &mfrActuator, const Model &model)
 
- Public Member Functions inherited from openstudio::model::StraightComponent
bool addToNode (Node &node)
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that this AirToAirComponent is attached to. More...
 
ModelObject clone (Model model) const
 
void disconnect ()
 
boost::optional< ModelObjectinletModelObject () const
 Returns the optional ModelObject connected to the inlet port. More...
 
unsigned inletPort () const
 Returns the inlet port. More...
 
StraightComponentoperator= (const StraightComponent &)=default
 
StraightComponentoperator= (StraightComponent &&)=default
 
boost::optional< ModelObjectoutletModelObject () const
 Returns the optional ModelObject connected to the outlet port. More...
 
unsigned outletPort () const
 Returns the outlet port. More...
 
std::vector
< openstudio::IdfObject > 
remove ()
 
bool removeFromLoop ()
 
 StraightComponent (IddObjectType type, const Model &model)
 
 StraightComponent (const StraightComponent &other)=default
 
 StraightComponent (StraightComponent &&other)=default
 
virtual ~StraightComponent ()=default
 
- Public Member Functions inherited from openstudio::model::HVACComponent
bool addToNode (Node &node)
 Adds this object to a new system node and returns a boolean indicating if the addition was successful. More...
 
bool addToSplitter (Splitter &splitter)
 Adds this object to a splitter by creating a new branch. More...
 
boost::optional< AirLoopHVACairLoopHVAC () const
 Returns the optional AirLoopHVAC object that the HVAC component is attached to. More...
 
boost::optional
< AirLoopHVACOutdoorAirSystem
airLoopHVACOutdoorAirSystem () const
 Returns the optional AirLoopHVACOutdoorAirSystem that the HVAC component is attached to. More...
 
std::vector< AppGFuelType > appGHeatingFuelTypes () const
 
void applySizingValues ()
 
void autosize ()
 Returns the optional ModelObject connected to this object's port. More...
 
ComponentType componentType () const
 
boost::optional< HVACComponentcontainingHVACComponent () const
 EnergyPlus unitary equipment and air terminals are typically composed of other HVAC components. More...
 
boost::optional
< StraightComponent
containingStraightComponent () const
 
boost::optional
< ZoneHVACComponent
containingZoneHVACComponent () const
 Returns any ZoneHVACComponent that contains this HVACComponent. More...
 
std::vector< FuelType > coolingFuelTypes () const
 
void disconnect ()
 Removes all connections to other HVACComponent objects. More...
 
std::vector< FuelType > heatingFuelTypes () const
 
 HVACComponent (const HVACComponent &other)=default
 
 HVACComponent (HVACComponent &&other)=default
 
bool isRemovable () const
 Indicates if the HVACComponent can be removed from the model. More...
 
boost::optional< Looploop () const
 Returns the optional Loop object that the HVAC component is attached to. More...
 
HVACComponentoperator= (const HVACComponent &)=default
 
HVACComponentoperator= (HVACComponent &&)=default
 
boost::optional< PlantLoopplantLoop () const
 Returns the optional PlantLoop object that the HVAC component is attached to. More...
 
std::vector< IdfObject > remove ()
 Removes the HVACComponent from the model only if isRemovable() return true. More...
 
virtual ~HVACComponent ()=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
ModelObject clone () const
 Creates a deep copy of this object, placing it in this object's model(). More...
 
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model. More...
 
Component createComponent () const
 Method for creating sharable Model snippets. More...
 
Model model () const
 Returns the Model that contains this object. More...
 
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject. More...
 
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object. More...
 
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object. More...
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index. More...
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points. More...
 
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object. More...
 
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
 
boost::optional
< openstudio::TimeSeries > 
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object. More...
 
std::vector< IdfObject > removeLifeCycleCosts ()
 Removes all LifeCycleCosts that refer to this object. More...
 
IddObjectType iddObjectType () const
 This is a virtual function that will tell you the type of iddObject you are dealing with. More...
 
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary. More...
 
bool hasAdditionalProperties () const
 Returns true if this object has additional properties. More...
 
std::vector< IdfObject > removeAdditionalProperties ()
 Removes all additional properties that refer to this object. More...
 
boost::optional< std::string > cadObjectId () const
 
bool setCADObjectId (const std::string &cadObjectId)
 
boost::optional< std::string > gbXMLId () const
 
bool setGBXMLId (const std::string &gbXMLId)
 
boost::optional< std::string > displayName () const
 
bool setDisplayName (const std::string &displayName)
 
bool setParent (ParentObject &newParent)
 set the parent, child may have to call non-const methods on the parent More...
 
bool operator< (const ModelObject &right) const
 
bool operator== (const ModelObject &other) const
 equality test More...
 
bool operator!= (const ModelObject &other) const
 inequality test More...
 
std::vector< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
 
boost::optional< double > getAutosizedValue (const std::string &valueName, const std::string &units) const
 Gets the autosized component value from the sql file. More...
 
virtual std::vector
< EMSActuatorNames
emsActuatorNames () const
 Return the names of the available ems actuators. More...
 
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables. More...
 
boost::optional< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
static std::vector< std::string > plantLoadingModeValues ()
 
static std::vector< std::string > plantLoopFlowRequestModeValues ()
 

Related Functions

(Note that these are not member functions.)

using OptionalPlantComponentUserDefined = boost::optional< PlantComponentUserDefined >
 
using PlantComponentUserDefinedVector = std::vector< PlantComponentUserDefined >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::HVACComponent
using ImplType = detail::HVACComponent_Impl
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Member Functions inherited from openstudio::model::HVACComponent
virtual std::vector< ModelObjectchildren () const
 
 HVACComponent (IddObjectType type, const Model &model)
 
 HVACComponent (std::shared_ptr< ImplType > impl)
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ModelObject
 ModelObject (IddObjectType type, const Model &model, bool fastName=false)
 
 ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)
 

Detailed Description

PlantComponentUserDefined is a StraightComponent that wraps the OpenStudio IDD object 'OS:PlantComponent:UserDefined'.

Constructor & Destructor Documentation

openstudio::model::PlantComponentUserDefined::PlantComponentUserDefined ( const Model model)
explicit
virtual openstudio::model::PlantComponentUserDefined::~PlantComponentUserDefined ( )
virtualdefault
openstudio::model::PlantComponentUserDefined::PlantComponentUserDefined ( const PlantComponentUserDefined other)
default
openstudio::model::PlantComponentUserDefined::PlantComponentUserDefined ( PlantComponentUserDefined &&  other)
default

Member Function Documentation

boost::optional<ThermalZone> openstudio::model::PlantComponentUserDefined::ambientZone ( ) const
EnergyManagementSystemProgram openstudio::model::PlantComponentUserDefined::createInitProgram ( const EnergyManagementSystemActuator dvfrActuator,
const EnergyManagementSystemActuator mmfrActuator,
const EnergyManagementSystemActuator mxfrActuator,
const EnergyManagementSystemActuator mlcActuator,
const EnergyManagementSystemActuator mxlcActuator,
const EnergyManagementSystemActuator olcActuator,
const Model model 
)
EnergyManagementSystemProgram openstudio::model::PlantComponentUserDefined::createSimProgram ( const EnergyManagementSystemActuator otActuator,
const EnergyManagementSystemActuator mfrActuator,
const Model model 
)
boost::optional<EnergyManagementSystemActuator> openstudio::model::PlantComponentUserDefined::designVolumeFlowRateActuator ( ) const
static IddObjectType openstudio::model::PlantComponentUserDefined::iddObjectType ( )
static
boost::optional<EnergyManagementSystemProgram> openstudio::model::PlantComponentUserDefined::mainModelProgram ( ) const
boost::optional<EnergyManagementSystemProgramCallingManager> openstudio::model::PlantComponentUserDefined::mainModelProgramCallingManager ( ) const
boost::optional<EnergyManagementSystemActuator> openstudio::model::PlantComponentUserDefined::massFlowRateActuator ( ) const
boost::optional<EnergyManagementSystemActuator> openstudio::model::PlantComponentUserDefined::maximumLoadingCapacityActuator ( ) const
boost::optional<EnergyManagementSystemActuator> openstudio::model::PlantComponentUserDefined::maximumMassFlowRateActuator ( ) const
boost::optional<EnergyManagementSystemActuator> openstudio::model::PlantComponentUserDefined::minimumLoadingCapacityActuator ( ) const
boost::optional<EnergyManagementSystemActuator> openstudio::model::PlantComponentUserDefined::minimumMassFlowRateActuator ( ) const
PlantComponentUserDefined& openstudio::model::PlantComponentUserDefined::operator= ( const PlantComponentUserDefined )
default
PlantComponentUserDefined& openstudio::model::PlantComponentUserDefined::operator= ( PlantComponentUserDefined &&  )
default
boost::optional<EnergyManagementSystemActuator> openstudio::model::PlantComponentUserDefined::optimalLoadingCapacityActuator ( ) const
boost::optional<EnergyManagementSystemActuator> openstudio::model::PlantComponentUserDefined::outletTemperatureActuator ( ) const
boost::optional<EnergyManagementSystemProgram> openstudio::model::PlantComponentUserDefined::plantInitializationProgram ( ) const
boost::optional<EnergyManagementSystemProgramCallingManager> openstudio::model::PlantComponentUserDefined::plantInitializationProgramCallingManager ( ) const
std::string openstudio::model::PlantComponentUserDefined::plantLoadingMode ( ) const
static std::vector<std::string> openstudio::model::PlantComponentUserDefined::plantLoadingModeValues ( )
static
std::string openstudio::model::PlantComponentUserDefined::plantLoopFlowRequestMode ( ) const
static std::vector<std::string> openstudio::model::PlantComponentUserDefined::plantLoopFlowRequestModeValues ( )
static
boost::optional<EnergyManagementSystemProgram> openstudio::model::PlantComponentUserDefined::plantSimulationProgram ( ) const
boost::optional<EnergyManagementSystemProgramCallingManager> openstudio::model::PlantComponentUserDefined::plantSimulationProgramCallingManager ( ) const
void openstudio::model::PlantComponentUserDefined::resetAmbientZone ( )
void openstudio::model::PlantComponentUserDefined::resetMainModelProgram ( )
void openstudio::model::PlantComponentUserDefined::resetMainModelProgramCallingManager ( )
void openstudio::model::PlantComponentUserDefined::resetPlantInitializationProgram ( )
void openstudio::model::PlantComponentUserDefined::resetPlantInitializationProgramCallingManager ( )
void openstudio::model::PlantComponentUserDefined::resetPlantSimulationProgram ( )
void openstudio::model::PlantComponentUserDefined::resetPlantSimulationProgramCallingManager ( )
bool openstudio::model::PlantComponentUserDefined::setAmbientZone ( const ThermalZone thermalZone)
bool openstudio::model::PlantComponentUserDefined::setDesignVolumeFlowRateActuator ( const EnergyManagementSystemActuator energyManagementSystemActuator)
bool openstudio::model::PlantComponentUserDefined::setMainModelProgram ( const EnergyManagementSystemProgram energyManagementSystemProgram)
bool openstudio::model::PlantComponentUserDefined::setMainModelProgramCallingManager ( const EnergyManagementSystemProgramCallingManager energyManagementSystemProgramCallingManager)
bool openstudio::model::PlantComponentUserDefined::setMassFlowRateActuator ( const EnergyManagementSystemActuator energyManagementSystemActuator)
bool openstudio::model::PlantComponentUserDefined::setMaximumLoadingCapacityActuator ( const EnergyManagementSystemActuator energyManagementSystemActuator)
bool openstudio::model::PlantComponentUserDefined::setMaximumMassFlowRateActuator ( const EnergyManagementSystemActuator energyManagementSystemActuator)
bool openstudio::model::PlantComponentUserDefined::setMinimumLoadingCapacityActuator ( const EnergyManagementSystemActuator energyManagementSystemActuator)
bool openstudio::model::PlantComponentUserDefined::setMinimumMassFlowRateActuator ( const EnergyManagementSystemActuator energyManagementSystemActuator)
bool openstudio::model::PlantComponentUserDefined::setOptimalLoadingCapacityActuator ( const EnergyManagementSystemActuator energyManagementSystemActuator)
bool openstudio::model::PlantComponentUserDefined::setOutletTemperatureActuator ( const EnergyManagementSystemActuator energyManagementSystemActuator)
bool openstudio::model::PlantComponentUserDefined::setPlantInitializationProgram ( const EnergyManagementSystemProgram energyManagementSystemProgram)
bool openstudio::model::PlantComponentUserDefined::setPlantInitializationProgramCallingManager ( const EnergyManagementSystemProgramCallingManager energyManagementSystemProgramCallingManager)
bool openstudio::model::PlantComponentUserDefined::setPlantLoadingMode ( const std::string &  plantLoadingMode)
bool openstudio::model::PlantComponentUserDefined::setPlantLoopFlowRequestMode ( const std::string &  plantLoopFlowRequestMode)
bool openstudio::model::PlantComponentUserDefined::setPlantSimulationProgram ( const EnergyManagementSystemProgram energyManagementSystemProgram)
bool openstudio::model::PlantComponentUserDefined::setPlantSimulationProgramCallingManager ( const EnergyManagementSystemProgramCallingManager energyManagementSystemProgramCallingManager)

Friends And Related Function Documentation