 |
OpenStudio:model |
#include <PortList.hpp>
Inheritance diagram for openstudio::model::PortList:Public Member Functions | |
| boost::optional< ModelObject > | airLoopHVACModelObject () const |
| Returns the object connected to an AirLoopHVAC object. More... | |
| std::vector< ModelObject > | airLoopHVACModelObjects () const |
| unsigned | airLoopHVACPort () const |
| Returns the port connected to an AirLoopHVAC object. More... | |
| unsigned | airLoopHVACPortIndex () const |
| Returns the port Index connected to an AirLoopHVAC object. More... | |
| std::vector< unsigned > | airLoopHVACPortIndexes () const |
| std::vector< unsigned > | airLoopHVACPorts () const |
| boost::optional< ModelObject > | lastModelObject () |
| Returns the optional ModelObject connected to the last port of the PortList. More... | |
| boost::optional< ModelObject > | modelObject (unsigned portIndex) const |
| Returns the optional ModelObject connected to the port designated by portIndex. More... | |
| std::vector< ModelObject > | modelObjects () const |
| Returns a vector of all objects connected to the PortList's ports. More... | |
| unsigned | nextPort () const |
| Returns the next available port. More... | |
| unsigned | nextPortIndex () const |
| Returns the index of the next available port. More... | |
| PortList & | operator= (const PortList &)=default |
| PortList & | operator= (PortList &&)=default |
| unsigned | port (unsigned portIndex) const |
| Returns the port for portIndex. More... | |
| unsigned | portIndex (unsigned port) const |
| Given a port, return the port index. More... | |
| unsigned | portIndexForModelObject (ModelObject &modelObject) const |
| Returns the port index for the ModelObject specified by modelObject. More... | |
| PortList (const HVACComponent &comp) | |
| PortList (const PortList &other)=default | |
| PortList (PortList &&other)=default | |
| ThermalZone | thermalZone () const |
| virtual | ~PortList ()=default |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| virtual | ~ModelObject ()=default |
| ModelObject (const ModelObject &other)=default | |
| ModelObject (ModelObject &&other)=default | |
| ModelObject & | operator= (const ModelObject &)=default |
| ModelObject & | operator= (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< ParentObject > | parent () const |
| Return this object's parent in the hierarchy, if it has one. More... | |
| std::vector< ResourceObject > | resources () 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< OutputVariable > | outputVariables () 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< LifeCycleCost > | lifeCycleCosts () 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< ScheduleTypeKey > | getScheduleTypeKeys (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< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
Related Functions | |
(Note that these are not member functions.) | |
| using | OptionalPortList = boost::optional< PortList > |
| using | PortListVector = std::vector< PortList > |
| Related Functions inherited from openstudio::model::ModelObject | |
| std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
| Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
Additional Inherited Members | |
| Protected Types inherited from openstudio::model::ModelObject | |
| using | ImplType = detail::ModelObject_Impl |
| 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) | |
PortList is a ModelObject that wraps the OpenStudio IDD object 'OS:PortList'.
|
explicit |
|
virtualdefault |
|
default |
|
default |
| boost::optional<ModelObject> openstudio::model::PortList::airLoopHVACModelObject | ( | ) | const |
Returns the object connected to an AirLoopHVAC object.
| std::vector<ModelObject> openstudio::model::PortList::airLoopHVACModelObjects | ( | ) | const |
| unsigned openstudio::model::PortList::airLoopHVACPort | ( | ) | const |
Returns the port connected to an AirLoopHVAC object.
If there is no AirLoopHVAC object, then the next available port is returned
| unsigned openstudio::model::PortList::airLoopHVACPortIndex | ( | ) | const |
Returns the port Index connected to an AirLoopHVAC object.
If there is no AirLoopHVAC object, then the next available portIndex is returned
| std::vector<unsigned> openstudio::model::PortList::airLoopHVACPortIndexes | ( | ) | const |
| std::vector<unsigned> openstudio::model::PortList::airLoopHVACPorts | ( | ) | const |
|
static |
| boost::optional<ModelObject> openstudio::model::PortList::lastModelObject | ( | ) |
Returns the optional ModelObject connected to the last port of the PortList.
If there are no connections to the list's outlet ports, then the optional will be false.
| boost::optional<ModelObject> openstudio::model::PortList::modelObject | ( | unsigned | portIndex | ) | const |
Returns the optional ModelObject connected to the port designated by portIndex.
If there is no connected object then the optional will be false.
| std::vector<ModelObject> openstudio::model::PortList::modelObjects | ( | ) | const |
| unsigned openstudio::model::PortList::nextPort | ( | ) | const |
Returns the next available port.
This will be the first port with no connected objects
| unsigned openstudio::model::PortList::nextPortIndex | ( | ) | const |
Returns the index of the next available port.
| unsigned openstudio::model::PortList::port | ( | unsigned | portIndex | ) | const |
Returns the port for portIndex.
Ports are consequtively indexed starting from 0.
| unsigned openstudio::model::PortList::portIndex | ( | unsigned | port | ) | const |
Given a port, return the port index.
Consider that a "port" is simply an unsigned, so port and port index share the same type, but they do not share the same value.
| unsigned openstudio::model::PortList::portIndexForModelObject | ( | ModelObject & | modelObject | ) | const |
Returns the port index for the ModelObject specified by modelObject.
| ThermalZone openstudio::model::PortList::thermalZone | ( | ) | const |
|
related |
|
related |