 |
OpenStudio:model |
|
OpenStudio:model |
#include <Component.hpp>
Inheritance diagram for openstudio::model::Component:Public Member Functions | |
Constructors and Destructors | |
| Component (const openstudio::IdfFile &idfFile) | |
| Construct from an IdfFile. More... | |
| virtual | ~Component () override=default |
| Component (const Component &other)=default | |
| Component (Component &&other)=default | |
| Component & | operator= (const Component &)=default |
| Component & | operator= (Component &&)=default |
Getters | |
| ComponentData | componentData () const |
| Returns the object that contains the contents list, unique identifiers, and timestamps for this Component. More... | |
| ModelObject | primaryObject () const |
| Returns the primary ModelObject of this Component. More... | |
| Public Member Functions inherited from openstudio::model::Model | |
| void | applySizingValues () |
| For each object in the model with autosizable fields, retrieves the autosized values from the sizing run and then sets these values in the object explicitly. More... | |
| void | autosize () |
| For each object in the model with autosizable fields, sets all autosizable fields to 'autosize'. More... | |
| void | connect (ModelObject sourceObject, unsigned sourcePort, ModelObject targetObject, unsigned targetPort) const |
| Connects the sourcePort on the source ModelObject to the targetPort on the target ModelObject. More... | |
| void | disconnect (ModelObject object, unsigned port) |
| Disconnects the port on the given ModelObject. More... | |
| template<> | |
| Building | getUniqueModelObject () |
| template<> | |
| FoundationKivaSettings | getUniqueModelObject () |
| template<> | |
| OutputControlFiles | getUniqueModelObject () |
| template<> | |
| OutputControlReportingTolerances | getUniqueModelObject () |
| template<> | |
| OutputControlTableStyle | getUniqueModelObject () |
| template<> | |
| OutputControlTimestamp | getUniqueModelObject () |
| template<> | |
| OutputDiagnostics | getUniqueModelObject () |
| template<> | |
| OutputDebuggingData | getUniqueModelObject () |
| template<> | |
| OutputJSON | getUniqueModelObject () |
| template<> | |
| OutputSQLite | getUniqueModelObject () |
| template<> | |
| OutputEnergyManagementSystem | getUniqueModelObject () |
| template<> | |
| OutputTableSummaryReports | getUniqueModelObject () |
| template<> | |
| OutputSchedules | getUniqueModelObject () |
| template<> | |
| OutputConstructions | getUniqueModelObject () |
| template<> | |
| PerformancePrecisionTradeoffs | getUniqueModelObject () |
| template<> | |
| LifeCycleCostParameters | getUniqueModelObject () |
| template<> | |
| SizingParameters | getUniqueModelObject () |
| template<> | |
| RadianceParameters | getUniqueModelObject () |
| template<> | |
| RunPeriod | getUniqueModelObject () |
| template<> | |
| RunPeriodControlDaylightSavingTime | getUniqueModelObject () |
| template<> | |
| YearDescription | getUniqueModelObject () |
| template<> | |
| Site | getUniqueModelObject () |
| template<> | |
| SiteGroundReflectance | getUniqueModelObject () |
| template<> | |
| SiteWaterMainsTemperature | getUniqueModelObject () |
| template<> | |
| SiteGroundTemperatureBuildingSurface | getUniqueModelObject () |
| template<> | |
| SiteGroundTemperatureFCfactorMethod | getUniqueModelObject () |
| template<> | |
| SiteGroundTemperatureDeep | getUniqueModelObject () |
| template<> | |
| SiteGroundTemperatureShallow | getUniqueModelObject () |
| template<> | |
| Facility | getUniqueModelObject () |
| template<> | |
| WeatherFile | getUniqueModelObject () |
| template<> | |
| SimulationControl | getUniqueModelObject () |
| template<> | |
| LightingSimulationControl | getUniqueModelObject () |
| template<> | |
| AirflowNetworkSimulationControl | getUniqueModelObject () |
| template<> | |
| InsideSurfaceConvectionAlgorithm | getUniqueModelObject () |
| template<> | |
| OutsideSurfaceConvectionAlgorithm | getUniqueModelObject () |
| template<> | |
| HeatBalanceAlgorithm | getUniqueModelObject () |
| template<> | |
| ZoneAirContaminantBalance | getUniqueModelObject () |
| template<> | |
| ZoneAirHeatBalanceAlgorithm | getUniqueModelObject () |
| template<> | |
| ZoneAirMassFlowConservation | getUniqueModelObject () |
| template<> | |
| ZoneCapacitanceMultiplierResearchSpecial | getUniqueModelObject () |
| template<> | |
| ConvergenceLimits | getUniqueModelObject () |
| template<> | |
| ShadowCalculation | getUniqueModelObject () |
| template<> | |
| Timestep | getUniqueModelObject () |
| template<> | |
| ClimateZones | getUniqueModelObject () |
| template<> | |
| EnvironmentalImpactFactors | getUniqueModelObject () |
| template<> | |
| ExternalInterface | getUniqueModelObject () |
| boost::optional< ComponentData > | insertComponent (const Component &component) |
| Inserts Component into Model and returns the primary object, if possible. More... | |
| std::vector< ModelObject > | modelObjects (bool sorted=false) const |
| Get all model objects. More... | |
| bool | operator== (const Model &other) const |
| Equality test, tests if this Model shares the same implementation object with other. More... | |
| std::vector < openstudio::IdfObject > | purgeUnusedResourceObjects () |
| Removes all ResourceObjects with nonResourceObjectUseCount() == 0. More... | |
| std::vector < openstudio::IdfObject > | purgeUnusedResourceObjects (IddObjectType iddObjectType) |
| Removes all ResourceObjects of given IddObjectType with directUseCount() == 0. More... | |
| Model () | |
| Creates a new, empty Model. More... | |
| Model (const openstudio::IdfFile &idfFile) | |
| Creates a new Model with one ModelObject for each IdfObject in the given IdfFile. More... | |
| Model (const openstudio::Workspace &workspace) | |
| Creates a new Model with one ModelObject for each WorkspaceObjects in the given Workspace. More... | |
| virtual | ~Model () override=default |
| Model (const Model &other)=default | |
| Model (Model &&other)=default | |
| Model & | operator= (const Model &)=default |
| Model & | operator= (Model &&)=default |
| WorkflowJSON | workflowJSON () const |
| Get the WorkflowJSON. More... | |
| boost::optional< SqlFile > | sqlFile () const |
| Returns the EnergyPlus output SqlFile if set. More... | |
| boost::optional< Building > | building () const |
| Get the Building object if there is one, this implementation uses a cached reference to the Building object which can be significantly faster than calling getOptionalUniqueModelObject<Building>(). More... | |
| boost::optional < FoundationKivaSettings > | foundationKivaSettings () const |
| Get the FoundationKivaSettings object if there is one, this implementation uses a cached reference to the FoundationKivaSettings object which can be significantly faster than calling getOptionalUniqueModelObject<FoundationKivaSettings>(). More... | |
| boost::optional < OutputControlFiles > | outputControlFiles () const |
| Get the OutputControlFiles object if there is one, this implementation uses a cached reference to the OutputControlFiles object which can be significantly faster than calling getOptionalUniqueModelObject<OutputControlFiles>(). More... | |
| boost::optional < OutputControlReportingTolerances > | outputControlReportingTolerances () const |
| Get the OutputControlReportingTolerances object if there is one, this implementation uses a cached reference to the OutputControlReportingTolerances object which can be significantly faster than calling getOptionalUniqueModelObject<OutputControlReportingTolerances>(). More... | |
| boost::optional < OutputControlTableStyle > | outputControlTableStyle () const |
| Get the OutputControlTableStyle object if there is one, this implementation uses a cached reference to the OutputControlTableStyle object which can be significantly faster than calling getOptionalUniqueModelObject<OutputControlTableStyle>(). More... | |
| boost::optional < OutputControlTimestamp > | outputControlTimestamp () const |
| Get the OutputControlTimestamp object if there is one, this implementation uses a cached reference to the OutputControlTimestamp object which can be significantly faster than calling getOptionalUniqueModelObject<OutputControlTimestamp>(). More... | |
| boost::optional < OutputDiagnostics > | outputDiagnostics () const |
| Get the OutputDiagnostics object if there is one, this implementation uses a cached reference to the OutputDiagnostics object which can be significantly faster than calling getOptionalUniqueModelObject<OutputDiagnostics>(). More... | |
| boost::optional < OutputDebuggingData > | outputDebuggingData () const |
| Get the OutputDebuggingData object if there is one, this implementation uses a cached reference to the OutputDebuggingData object which can be significantly faster than calling getOptionalUniqueModelObject<OutputDebuggingData>(). More... | |
| boost::optional< OutputJSON > | outputJSON () const |
| Get the OutputJSON object if there is one, this implementation uses a cached reference to the OutputJSON object which can be significantly faster than calling getOptionalUniqueModelObject<OutputJSON>(). More... | |
| boost::optional< OutputSQLite > | outputSQLite () const |
| Get the OutputSQLite object if there is one, this implementation uses a cached reference to the OutputSQLite object which can be significantly faster than calling getOptionalUniqueModelObject<OutputSQLite>(). More... | |
| boost::optional < OutputEnergyManagementSystem > | outputEnergyManagementSystem () const |
| Get the OutputEnergyManagementSystem object if there is one, this implementation uses a cached reference to the OutputEnergyManagementSystem object which can be significantly faster than calling getOptionalUniqueModelObject<OutputControlFiles>(). More... | |
| boost::optional < OutputTableSummaryReports > | outputTableSummaryReports () const |
| Get the OutputTableSummaryReports object if there is one, this implementation uses a cached reference to the OutputTableSummaryReports object which can be significantly faster than calling getOptionalUniqueModelObject<OutputTableSummaryReports>(). More... | |
| boost::optional< OutputSchedules > | outputSchedules () const |
| Get the OutputSchedules object if there is one, this implementation uses a cached reference to the OutputSchedules object which can be significantly faster than calling getOptionalUniqueModelObject<OutputSchedules>(). More... | |
| boost::optional < OutputConstructions > | outputConstructions () const |
| Get the OutputConstructions object if there is one, this implementation uses a cached reference to the OutputConstructions object which can be significantly faster than calling getOptionalUniqueModelObject<OutputConstructions>(). More... | |
| boost::optional < PerformancePrecisionTradeoffs > | performancePrecisionTradeoffs () const |
| Get the PerformancePrecisionTradeoffs object if there is one, this implementation uses a cached reference to the PerformancePrecisionTradeoffs object which can be significantly faster than calling getOptionalUniqueModelObject<PerformancePrecisionTradeoffs>(). More... | |
| boost::optional < LifeCycleCostParameters > | lifeCycleCostParameters () const |
| Get the LifeCycleCostParameters object if there is one, this implementation uses a cached reference to the LifeCycleCostParameters object which can be significantly faster than calling getOptionalUniqueModelObject<LifeCycleCostParameters>(). More... | |
| boost::optional< SizingParameters > | sizingParameters () const |
| Get the SizingParameters object if there is one, this implementation uses a cached reference to the SizingParameters object which can be significantly faster than calling getOptionalUniqueModelObject<SizingParameters>(). More... | |
| boost::optional < RadianceParameters > | radianceParameters () const |
| Get the RadianceParameters object if there is one, this implementation uses a cached reference to the RadianceParameters object which can be significantly faster than calling getOptionalUniqueModelObject<RadianceParameters>(). More... | |
| boost::optional< RunPeriod > | runPeriod () const |
| Get the RunPeriod object if there is one, this implementation uses a cached reference to the RunPeriod object which can be significantly faster than calling getOptionalUniqueModelObject<RunPeriod>(). More... | |
| boost::optional < RunPeriodControlDaylightSavingTime > | runPeriodControlDaylightSavingTime () const |
| Get the RunPeriodControlDaylightSavingTime object if there is one, this implementation uses a cached reference to the RunPeriodControlDaylightSavingTime object which can be significantly faster than calling getOptionalUniqueModelObject<RunPeriodControlDaylightSavingTime>(). More... | |
| boost::optional< YearDescription > | yearDescription () const |
| Get the YearDescription object if there is one, this implementation uses a cached reference to the YearDescription object which can be significantly faster than calling getOptionalUniqueModelObject<YearDescription>(). More... | |
| boost::optional< Site > | site () const |
| Get the Site object if there is one, this implementation uses a cached reference to the Site object which can be significantly faster than calling getOptionalUniqueModelObject<Site>(). More... | |
| boost::optional < SiteGroundReflectance > | siteGroundReflectance () const |
| Get the SiteGroundReflectance object if there is one, this implementation uses a cached reference to the SiteGroundReflectance object which can be significantly faster than calling getOptionalUniqueModelObject<SiteGroundReflectance>(). More... | |
| boost::optional < SiteWaterMainsTemperature > | siteWaterMainsTemperature () const |
| Get the SiteWaterMainsTemperature object if there is one, this implementation uses a cached reference to the SiteWaterMainsTemperature object which can be significantly faster than calling getOptionalUniqueModelObject<SiteWaterMainsTemperature>(). More... | |
| boost::optional < SiteGroundTemperatureBuildingSurface > | siteGroundTemperatureBuildingSurface () const |
| Get the SiteGroundTemperatureBuildingSurface object if there is one, this implementation uses a cached reference to the SiteGroundTemperatureBuildingSurface object which can be significantly faster than calling getOptionalUniqueModelObject<SiteGroundTemperatureBuildingSurface>(). More... | |
| boost::optional < SiteGroundTemperatureFCfactorMethod > | siteGroundTemperatureFCfactorMethod () const |
| Get the SiteGroundTemperatureFCfactorMethod object if there is one, this implementation uses a cached reference to the SiteGroundTemperatureFCfactorMethod object which can be significantly faster than calling getOptionalUniqueModelObject<SiteGroundTemperatureFCfactorMethod>(). More... | |
| boost::optional < SiteGroundTemperatureDeep > | siteGroundTemperatureDeep () const |
| Get the SiteGroundTemperatureDeep object if there is one, this implementation uses a cached reference to the SiteGroundTemperatureDeep object which can be significantly faster than calling getOptionalUniqueModelObject<SiteGroundTemperatureDeep>(). More... | |
| boost::optional < SiteGroundTemperatureShallow > | siteGroundTemperatureShallow () const |
| Get the SiteGroundTemperatureShallow object if there is one, this implementation uses a cached reference to the SiteGroundTemperatureShallow object which can be significantly faster than calling getOptionalUniqueModelObject<SiteGroundTemperatureShallow>(). More... | |
| boost::optional< Facility > | facility () const |
| Get the Facility object if there is one, this implementation uses a cached reference to the Facility object which can be significantly faster than calling getOptionalUniqueModelObject<Facility>(). More... | |
| boost::optional< WeatherFile > | weatherFile () const |
| Get the WeatherFile object if there is one, this implementation uses a cached reference to the WeatherFile object which can be significantly faster than calling getOptionalUniqueModelObject<WeatherFile>(). More... | |
| boost::optional < SimulationControl > | simulationControl () const |
| Get the SimulationControl object if there is one, this implementation uses a cached reference to the SimulationControl object which can be significantly faster than calling getOptionalUniqueModelObject<SimulationControl>(). More... | |
| boost::optional < LightingSimulationControl > | lightingSimulationControl () const |
| Get the LightingSimulationControl object if there is one, this implementation uses a cached reference to the LightingSimulationControl object which can be significantly faster than calling getOptionalUniqueModelObject<LightingSimulationControl>(). More... | |
| boost::optional < AirflowNetworkSimulationControl > | airflowNetworkSimulationControl () const |
| Get the AirflowNetworkSimulationControl object if there is one, this implementation uses a cached reference to the AirflowNetworkSimulationControl object which can be significantly faster than calling getOptionalUniqueModelObject<AirflowNetworkSimulationControl>(). More... | |
| boost::optional < InsideSurfaceConvectionAlgorithm > | insideSurfaceConvectionAlgorithm () const |
| Get the InsideSurfaceConvectionAlgorithm object if there is one, this implementation uses a cached reference to the InsideSurfaceConvectionAlgorithm object which can be significantly faster than calling getOptionalUniqueModelObject<InsideSurfaceConvectionAlgorithm>(). More... | |
| boost::optional < OutsideSurfaceConvectionAlgorithm > | outsideSurfaceConvectionAlgorithm () const |
| Get the OutsideSurfaceConvectionAlgorithm object if there is one, this implementation uses a cached reference to the OutsideSurfaceConvectionAlgorithm object which can be significantly faster than calling getOptionalUniqueModelObject<OutsideSurfaceConvectionAlgorithm>(). More... | |
| boost::optional < HeatBalanceAlgorithm > | heatBalanceAlgorithm () const |
| Get the HeatBalanceAlgorithm object if there is one, this implementation uses a cached reference to the HeatBalanceAlgorithm object which can be significantly faster than calling getOptionalUniqueModelObject<HeatBalanceAlgorithm>(). More... | |
| boost::optional < ZoneAirContaminantBalance > | zoneAirContaminantBalance () const |
| Get the ZoneAirContaminantBalance object if there is one, this implementation uses a cached reference to the ZoneAirContaminantBalance object which can be significantly faster than calling getOptionalUniqueModelObject<ZoneAirContaminantBalance>(). More... | |
| boost::optional < ZoneAirHeatBalanceAlgorithm > | zoneAirHeatBalanceAlgorithm () const |
| Get the ZoneAirHeatBalanceAlgorithm object if there is one, this implementation uses a cached reference to the ZoneAirHeatBalanceAlgorithm object which can be significantly faster than calling getOptionalUniqueModelObject<ZoneAirHeatBalanceAlgorithm>(). More... | |
| boost::optional < ZoneAirMassFlowConservation > | zoneAirMassFlowConservation () const |
| Get the ZoneAirMassFlowConservation object if there is one, this implementation uses a cached reference to the ZoneAirMassFlowConservation object which can be significantly faster than calling getOptionalUniqueModelObject<ZoneAirMassFlowConservation>(). More... | |
| boost::optional < ZoneCapacitanceMultiplierResearchSpecial > | zoneCapacitanceMultiplierResearchSpecial () const |
| Get the ZoneCapacitanceMultiplierResearchSpecial object if there is one, this implementation uses a cached reference to the ZoneCapacitanceMultiplierResearchSpecial object which can be significantly faster than calling getOptionalUniqueModelObject<ZoneCapacitanceMultiplierResearchSpecial>(). More... | |
| boost::optional < ConvergenceLimits > | convergenceLimits () const |
| Get the ConvergenceLimits object if there is one, this implementation uses a cached reference to the ConvergenceLimits object which can be significantly faster than calling getOptionalUniqueModelObject<ConvergenceLimits>(). More... | |
| boost::optional < ShadowCalculation > | shadowCalculation () const |
| Get the ShadowCalculation object if there is one, this implementation uses a cached reference to the ShadowCalculation object which can be significantly faster than calling getOptionalUniqueModelObject<ShadowCalculation>(). More... | |
| boost::optional< Timestep > | timestep () const |
| Get the Timestep object if there is one, this implementation uses a cached reference to the Timestep object which can be significantly faster than calling getOptionalUniqueModelObject<Timestep>(). More... | |
| boost::optional< ClimateZones > | climateZones () const |
| Get the ClimateZones object if there is one, this implementation uses a cached reference to the ClimateZones object which can be significantly faster than calling getOptionalUniqueModelObject<ClimateZones>(). More... | |
| boost::optional < EnvironmentalImpactFactors > | environmentalImpactFactors () const |
| Get the EnvironmentalImpactFactors object if there is one, this implementation uses a cached reference to the EnvironmentalImpactFactors object which can be significantly faster than calling getOptionalUniqueModelObject<EnvironmentalImpactFactors>(). More... | |
| boost::optional < ExternalInterface > | externalInterface () const |
| Get the ExternalInterface object if there is one, this implementation uses a cached reference to the ExternalInterface object which can be significantly faster than calling getOptionalUniqueModelObject<ExternalInterface>(). More... | |
| boost::optional< int > | calendarYear () const |
| Get or create the YearDescription object if there is one, then call method from YearDescription. More... | |
| std::string | dayofWeekforStartDay () const |
| bool | isDayofWeekforStartDayDefaulted () const |
| bool | isLeapYear () const |
| bool | isIsLeapYearDefaulted () const |
| bool | setCalendarYear (int calendarYear) |
| void | resetCalendarYear () |
| bool | setDayofWeekforStartDay (const std::string &dayofWeekforStartDay) |
| void | resetDayofWeekforStartDay () |
| bool | setIsLeapYear (bool isLeapYear) |
| void | resetIsLeapYear () |
| int | assumedYear () |
| openstudio::Date | makeDate (openstudio::MonthOfYear monthOfYear, unsigned dayOfMonth) |
| openstudio::Date | makeDate (unsigned monthOfYear, unsigned dayOfMonth) |
| openstudio::Date | makeDate (openstudio::NthDayOfWeekInMonth n, openstudio::DayOfWeek dayOfWeek, openstudio::MonthOfYear monthOfYear) |
| openstudio::Date | makeDate (unsigned dayOfYear) |
| Schedule | alwaysOnDiscreteSchedule () const |
| Get an always on schedule with discrete type limits if there is one. More... | |
| std::string | alwaysOnDiscreteScheduleName () const |
| Get the always on schedule with discrete type limits name. More... | |
| Schedule | alwaysOffDiscreteSchedule () const |
| Get an always off schedule with discrete type limits if there is one. More... | |
| std::string | alwaysOffDiscreteScheduleName () const |
| Get the always off schedule with discrete type limits name. More... | |
| Schedule | alwaysOnContinuousSchedule () const |
| Get an always on schedule with continuous type limits if there is one. More... | |
| std::string | alwaysOnContinuousScheduleName () const |
| Get the always on schedule with continuous type limits name. More... | |
| Node | outdoorAirNode () const |
| Get a Node named 'Model Outdoor Air Node' (intended to be forward translated to an OutdoorAir:Node) and not connected to a PlantLoop or AirLoopHVAC. More... | |
| SpaceType | plenumSpaceType () const |
| Get the space type used for plenums if there is one. More... | |
| std::string | plenumSpaceTypeName () const |
| Get the space type name used for plenums. More... | |
| bool | setWorkflowJSON (const WorkflowJSON &workflowJSON) |
| Set the WorkflowJSON. More... | |
| void | resetWorkflowJSON () |
| Reset the WorkflowJSON. More... | |
| bool | setSqlFile (const SqlFile &sqlFile) |
| Sets the EnergyPlus output SqlFile. More... | |
| bool | resetSqlFile () |
| Resets the EnergyPlus output SqlFile. More... | |
| template<typename T > | |
| boost::optional< T > | getModelObject (const Handle &handle) const |
| Returns the ModelObject referenced by handle if it is of type T. More... | |
| template<typename T > | |
| T | getUniqueModelObject () |
| Returns the unique ModelObject of type T, creates a one if none are found. More... | |
| template<typename T > | |
| boost::optional< T > | getOptionalUniqueModelObject () const |
| Returns the unique ModelObject of type T if it is found. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjects (bool sorted=false) const |
| Returns all ModelObjects of type T. More... | |
| template<typename T > | |
| std::vector< T > | getConcreteModelObjects () const |
| Returns all ModelObjects of type T, using T::iddObjectType() to speed up the search. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjects (const std::vector< openstudio::Handle > &handles) const |
| Returns the subset of ModelObjects referenced by handles which are of type T. More... | |
| template<typename T > | |
| boost::optional< T > | getModelObjectByName (const std::string &name) const |
| Returns the ModelObjects of type T with name (exactMatch). More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectsByName (const std::string &name, bool exactMatch=true) const |
| Returns all ModelObjects of type T with given name. More... | |
| template<typename T > | |
| boost::optional< T > | getConcreteModelObjectByName (const std::string &name) const |
| template<typename T > | |
| std::vector< T > | getConcreteModelObjectsByName (const std::string &name) const |
| Public Member Functions inherited from openstudio::Workspace | |
| std::vector< WorkspaceObject > | addAndInsertObjects (const std::vector< IdfObject > &objectsToAdd, const std::vector< IdfObject > &objectsToInsert) |
| std::vector< WorkspaceObject > | addAndInsertObjects (const std::vector< WorkspaceObject > &objectsToAdd, const std::vector< WorkspaceObject > &objectsToInsert) |
| std::vector< WorkspaceObject > | addAndInsertObjects (const std::vector< WorkspaceObject > &objectsToAdd, const std::vector< std::vector< WorkspaceObject >> &objectsToInsert) |
| boost::optional< WorkspaceObject > | addObject (const IdfObject &idfObject) |
| std::vector< WorkspaceObject > | addObjects (const std::vector< IdfObject > &idfObjects, bool checkNames=true) |
| std::vector< WorkspaceObject > | addObjects (const std::vector< WorkspaceObject > &objects, bool checkNames=true) |
| bool | canBeTarget (const Handle &handle, const std::set< std::string > &referenceListNames) const |
| T | cast () const |
| Workspace | clone (bool keepHandles=false) const |
| Workspace | cloneSubset (const std::vector< Handle > &handles, bool keepHandles=false, StrictnessLevel level=openstudio::StrictnessLevel::Draft) const |
| bool | connectProgressBar (openstudio::ProgressBar &progressBar) |
| bool | disconnectProgressBar (openstudio::ProgressBar &progressBar) |
| bool | fastNaming () const |
| boost::optional< IddObject > | getIddObject (const IddObjectType &type) const |
| boost::optional< WorkspaceObject > | getObject (Handle handle) const |
| boost::optional< WorkspaceObject > | getObjectByNameAndReference (const std::string &name, const std::vector< std::string > &referenceNames) const |
| boost::optional< WorkspaceObject > | getObjectByTypeAndName (IddObjectType objectType, const std::string &name) const |
| boost::optional< WorkspaceObject > | getObjectByTypeAndName (const std::string &objectTypeName, const std::string &name) const |
| std::vector< WorkspaceObject > | getObjects (const std::vector< Handle > &handles) const |
| std::vector< WorkspaceObject > | getObjectsByName (const std::string &name, bool exactMatch=true) const |
| std::vector< WorkspaceObject > | getObjectsByReference (const std::string &referenceName) const |
| std::vector< WorkspaceObject > | getObjectsByReference (const std::vector< std::string > &referenceNames) const |
| std::vector< WorkspaceObject > | getObjectsByType (IddObjectType objectType) const |
| std::vector< WorkspaceObject > | getObjectsByType (const IddObject &objectType) const |
| std::vector< WorkspaceObject > | getObjectsByType (const std::string &objectTypeName) const |
| std::vector< WorkspaceObject > | getObjectsByTypeAndName (const std::string &objectTypeName, const std::string &name) const |
| std::vector< WorkspaceObject > | getObjectsByTypeAndName (IddObjectType objectType, const std::string &name) const |
| std::vector< Handle > | handles (bool sorted=false) const |
| IddFile | iddFile () const |
| IddFileType | iddFileType () const |
| boost::optional< WorkspaceObject > | insertObject (const IdfObject &idfObject) |
| std::vector< WorkspaceObject > | insertObjects (const std::vector< IdfObject > &idfObjects) |
| std::vector< WorkspaceObject > | insertObjects (const std::vector< WorkspaceObject > &objects) |
| bool | isInIddFile (IddObjectType type) const |
| bool | isMember (const Handle &handle) const |
| bool | isValid (StrictnessLevel level) const |
| bool | isValid () const |
| boost::optional< std::string > | name (const Handle &handle) const |
| std::string | nextName (const IddObjectType &iddObjectType, bool fillIn) const |
| std::string | nextName (const std::string &name, bool fillIn) const |
| unsigned | numObjects () const |
| unsigned | numObjectsOfType (const IddObject &objectType) const |
| unsigned | numObjectsOfType (IddObjectType type) const |
| std::vector< WorkspaceObject > | objects (bool sorted=false) const |
| std::vector< WorkspaceObject > | objectsWithURLFields () const |
| bool | operator!= (const Workspace &other) const |
| std::ostream & | operator<< (std::ostream &os, const Workspace &workspace) |
| bool | operator== (const Workspace &other) const |
| boost::optional< T > | optionalCast () const |
| const WorkspaceObjectOrder | order () const |
| WorkspaceObjectOrder | order () |
| bool | removeObject (const Handle &handle) |
| bool | removeObjects (const std::vector< Handle > &handles) |
| bool | save (const openstudio::path &p, bool overwrite=false) |
| void | setFastNaming (bool fastNaming) |
| bool | setStrictnessLevel (StrictnessLevel level) |
| std::vector< Handle > | sort (const std::vector< Handle > &handles) const |
| std::vector< WorkspaceObject > | sort (const std::vector< WorkspaceObject > &objects) const |
| StrictnessLevel | strictnessLevel () const |
| void | swap (Workspace &other) |
| bool | swap (WorkspaceObject ¤tObject, IdfObject &newObject, bool keepTargets=false) |
| IdfFile | toIdfFile () const |
| ValidityReport | validityReport (StrictnessLevel level) const |
| ValidityReport | validityReport () const |
| VersionString | version () const |
| boost::optional< WorkspaceObject > | versionObject () const |
| Workspace (const Workspace &other) | |
| Workspace () | |
| Workspace (StrictnessLevel level) | |
| Workspace (StrictnessLevel level, IddFileType iddFileType) | |
| Workspace (const IdfFile &idfFile, StrictnessLevel level=openstudio::StrictnessLevel::Minimal) | |
| virtual | ~Workspace ()=default |
Protected Member Functions | |
| Component (const std::vector< ModelObject > &contents) | |
| Construct from a vector of ModelObjects, all in the same .model(). More... | |
| Protected Member Functions inherited from openstudio::Workspace | |
| virtual void | addVersionObject () |
| std::vector< WorkspaceObject > | allObjects () const |
| Workspace (std::shared_ptr< detail::Workspace_Impl > impl) | |
Related Functions | |
(Note that these are not member functions.) | |
| using | ComponentVector = std::vector< Component > |
| using | OptionalComponent = boost::optional< Component > |
| Related Functions inherited from openstudio::model::Model | |
| bool | compareInputAndOutput (const ModelObject &object, const std::string &attributeName, double inputResult, double outputResult, double tol, LogLevel logLevel=LogLevel::Debug) |
| Compare inputResult to outputResult. More... | |
| using | ModelVector = std::vector< Model > |
| using | OptionalModel = boost::optional< Model > |
Serialization | |
| virtual bool | save (const openstudio::path &p, bool overwrite=false) |
| Save Component to path p. More... | |
| static boost::optional< Component > | load (const path &p) |
| Load Component from path p, if possible. More... | |
Additional Inherited Members | |
| Public Types inherited from openstudio::Workspace | |
| typedef boost::optional < Workspace > | OptionalWorkspace |
| typedef std::vector< Workspace > | WorkspaceVector |
| Static Public Member Functions inherited from openstudio::model::Model | |
| static boost::optional< Model > | load (const path &osmPath) |
| Load Model from file, attempts to load WorkflowJSON from standard path. More... | |
| static boost::optional< Model > | load (const path &osmPath, const path &workflowJSONPath) |
| Load Model and WorkflowJSON from files, fails if either osm or workflowJSON cannot be loaded. More... | |
| Static Public Member Functions inherited from openstudio::Workspace | |
| static boost::optional< Workspace > | load (const openstudio::path &p) |
| static boost::optional< Workspace > | load (const openstudio::path &p, const IddFile &iddFile) |
| static boost::optional< Workspace > | load (const openstudio::path &p, const IddFileType &iddFileType) |
| Protected Types inherited from openstudio::Workspace | |
| typedef detail::Workspace_Impl | ImplType |
Component is a Model that contains exactly one ComponentData object.
All objects other than the ComponentData object and the version object are the Component contents. There is a primary ModelObject that provides the Component's type. There are no public constructors, as Components are to be constructed through the ModelObject method createComponent. Similarly, Model-level object addition and removal, and SqlFile functionality, has been disabled.
|
explicit |
Construct from an IdfFile.
Must contain exactly one ComponentData object, and contents list in ComponentData must exactly match the contents of idfFile.
|
overridevirtualdefault |
|
default |
|
default |
|
protected |
Construct from a vector of ModelObjects, all in the same .model().
The primary object must be listed first. Throws if contents.empty() or if more than one .model() is found. StrictnessLevel is always set to Draft. Not for general use; used by ModelObject::createComponent.
| ComponentData openstudio::model::Component::componentData | ( | ) | const |
Returns the object that contains the contents list, unique identifiers, and timestamps for this Component.
|
static |
Load Component from path p, if possible.
| ModelObject openstudio::model::Component::primaryObject | ( | ) | const |
Returns the primary ModelObject of this Component.
Can be used to access the Component type by using .optionalCast or iddObjectType().
|
virtual |
Save Component to path p.
Will construct the parent folder if its parent folder exists. An existing file will only be overwritten if if overwrite==true. If no extension is provided, componentFileExtension() will be used.
|
related |
|
related |
