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

#include <PortList.hpp>

+ Inheritance diagram for openstudio::model::PortList:

Public Member Functions

boost::optional< ModelObjectairLoopHVACModelObject () const
 Returns the object connected to an AirLoopHVAC object. More...
 
std::vector< ModelObjectairLoopHVACModelObjects () 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< ModelObjectlastModelObject ()
 Returns the optional ModelObject connected to the last port of the PortList. More...
 
boost::optional< ModelObjectmodelObject (unsigned portIndex) const
 Returns the optional ModelObject connected to the port designated by portIndex. More...
 
std::vector< ModelObjectmodelObjects () 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...
 
PortListoperator= (const PortList &)=default
 
PortListoperator= (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
 
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< IdfObjectremoveLifeCycleCosts ()
 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< IdfObjectremoveAdditionalProperties ()
 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
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
virtual ~WorkspaceObject ()=default
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
boost::optional< std::string > getField (unsigned index, bool returnDefault=false) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (IdfObject &&other) noexcept
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level, bool checkNames=false) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
IdfObjectoperator= (const IdfObject &other)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
IdfExtensibleGroup pushExtensibleGroup ()
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=false) const
 
virtual ~IdfObject ()=default
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Functions

(Note that these are not member functions.)

using OptionalPortList = boost::optional< PortList >
 
using PortListVector = std::vector< PortList >
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef
detail::WorkspaceObject_Impl 
ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 
- 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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Detailed Description

PortList is a ModelObject that wraps the OpenStudio IDD object 'OS:PortList'.

Constructor & Destructor Documentation

openstudio::model::PortList::PortList ( const HVACComponent comp)
explicit
virtual openstudio::model::PortList::~PortList ( )
virtualdefault
openstudio::model::PortList::PortList ( const PortList other)
default
openstudio::model::PortList::PortList ( PortList &&  other)
default

Member Function Documentation

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 IddObjectType openstudio::model::PortList::iddObjectType ( )
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

Returns a vector of all objects connected to the PortList's ports.

If no objects are connected to the PortList then an empty vector will be returned.

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.

PortList& openstudio::model::PortList::operator= ( const PortList )
default
PortList& openstudio::model::PortList::operator= ( PortList &&  )
default
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

Friends And Related Function Documentation

using OptionalPortList = boost::optional<PortList>
related
using PortListVector = std::vector<PortList>
related