openstudio Namespace Reference

Namespaces
	energyplus
	measuretab
	model
	osversion
	runmanager

Classes
class	AirLoopHVACUnitaryHeatPumpAirToAirControlView
class	AirLoopHVACUnitarySystemInspectorView
class	AirTerminalInspectorView
class	AirTerminalSingleDuctConstantVolumeCooledBeamInspectorView
class	AirTerminalSingleDuctConstantVolumeFourPipeInductionInspectorView
class	AirTerminalSingleDuctConstantVolumeReheatInspectorView
class	AirTerminalSingleDuctParallelPIUReheatInspectorView
class	AirTerminalSingleDuctSeriesPIUReheatInspectorView
class	AirTerminalSingleDuctVAVHeatAndCoolReheatInspectorView
class	AirTerminalSingleDuctVAVReheatInspectorView
class	ApplyMeasureNowDialog
class	BaseInspectorView
class	BCLComponentItem
class	BillingPeriodWidget
class	BuildingDefaultConstructionSetVectorController
class	BuildingDefaultScheduleSetVectorController
class	BuildingInspectorView
class	BuildingShadingTreeItem
class	BuildingShadingVC
class	BuildingSpaceTypeVectorController
class	BuildingStoryTreeItem
class	BuildingTreeItem
class	CalendarSegmentItem
class	CaseViewExpandButton
class	ColdWaterJunctionItem
class	CollapsibleInspector
class	CollapsibleInspectorHeader
class	ConstructionCfactorUndergroundWallInspectorView
class	ConstructionFfactorGroundFloorInspectorView
class	ConstructionInspectorView
class	ConstructionInternalSourceInspectorView
class	ConstructionObjectVectorController
class	ConstructionsController
class	ConstructionsInspectorView
class	ConstructionsTabController
class	ConstructionsTabView
class	ConstructionsView
class	ConstructionWindowDataFileInspectorView
class	DataPointJobContentView
class	DataPointJobHeaderView
class	DataPointJobItemView
class	DaylightingObjectsTreeItem
class	DayScheduleOverview
class	DaySchedulePlotArea
class	DayScheduleScene
class	DefaultConstructionSetInspectorView
class	DefaultConstructionSetsController
class	DefaultConstructionSetsView
class	DefaultInspectorView
class	DefaultScheduleDayView
class	DemandSideItem
class	DesignDayGridController
class	DesignDayGridView
class	DoorVC
class	DoubleOneThreeStraightItem
class	DoubleThreeFourStraightItem
class	DoubleTwoFourStraightItem
class	DoubleTwoThreeFourStraightItem
class	DoubleTwoThreeStraightItem
class	DualDuctTee
class	ElectricEquipmentDefinitionInspectorView
class	ElectricEquipmentScheduleVC
class	FacilityExteriorEquipmentGridController
class	FacilityExteriorEquipmentGridView
class	FacilityShadingGridController
class	FacilityShadingGridView
class	FacilityStoriesGridController
class	FacilityStoriesGridView
class	FacilityTabController
class	FacilityTabView
class	FixedWindowVC
class	FloorConstructionVC
class	FloorsTreeItem
class	FollowOATempSPMView
class	FourFiveNodeItem
class	FourTwoStraightItem
class	GasEquipmentDefinitionInspectorView
class	GasEquipmentScheduleVC
class	GenericInspectorView
class	GlassDoorConstructionVC
class	GridItem
class	GridScene
class	GridViewSubTab
class	HalfHeightItem
class	HalfHeightOneThreeNodeItem
class	HalfHeightOneThreeStraightItem
class	HorizontalBranchGroupItem
class	HorizontalBranchItem
class	HorizontalTabWidget
class	HotWaterEquipmentScheduleVC
class	HotWaterJunctionItem
class	HotWaterSupplyItem
class	HoursOfOperationVC
class	HVACControlsController
class	HVACControlsView
class	HVACGraphicsView
class	HVACLayoutController
class	HVACSystemsController
class	HVACSystemsTabController
class	HVACSystemsTabView
class	HVACSystemsView
class	HVACTemplateHelperDialog
class	HVACToolbarView
class	IconLibrary
class	InfiltrationScheduleVC
class	InspectorController
class	InspectorView
class	InteriorPartitionsTreeItem
class	InteriorPartitionSurfaceGroupTreeItem
class	InteriorPartitionsVC
class	InternalMassDefinitionInspectorView
class	LatentFractionScheduleVC
class	LibraryTabWidget
class	LifeCycleCostsTabView
class	LifeCycleCostsView
class	LightingScheduleVC
class	LightsDefinitionInspectorView
class	LinkItem
class	LoadsController
class	LoadsInspectorView
class	LoadsTabController
class	LoadsTabView
class	LoadsTreeItem
class	LoadsView
class	LocationTabController
class	LocationTabView
class	LocationView
class	LoopChooserItem
class	LoopChooserView
class	LoopItemView
class	LoopLibraryDialog
class	LoopScene
class	LuminaireDefinitionInspectorView
class	MainMenu
class	MainRightColumnController
class	MainsSupplyItem
class	MainTabController
class	MainTabView
class	MainWindow
class	MakeupWaterItem
class	MaterialAirGapInspectorView
class	MaterialAirWallInspectorView
class	MaterialInfraredTransparentInspectorView
class	MaterialInspectorView
class	MaterialNoMassInspectorView
class	MaterialRoofVegetationInspectorView
class	MaterialsController
class	MaterialsInspectorView
class	MaterialsView
class	MechanicalVentilationView
class	MixerItem
class	ModelObjectGraphicsItem
class	ModelObjectInspectorView
class	ModelObjectItem
class	ModelObjectListController
class	ModelObjectListView
class	ModelObjectTreeItem
class	ModelObjectTreeWidget
class	ModelObjectTypeItem
class	ModelObjectTypeListView
class	ModelObjectVectorController
class	ModelSubTabController
class	ModelSubTabView
class	MonthView
class	NewPlenumDialog
class	NewProfileView
class	NewSpaceLoadVectorController
class	NoBuildingStoryTreeItem
class	NoControlsView
class	NodeContextButtonItem
class	NoMechanicalVentilationView
class	NoSpaceTypeTreeItem
class	NoSupplyAirTempControlView
class	NoThermalZoneTreeItem
class	NumberOfPeopleVC
class	OAAirToAirItem
class	OAEndNodeItem
class	OAMixerItem
class	OAReliefBranchItem
class	OAReliefStraightItem
class	OAResetSPMView
class	OAStraightNodeItem
class	OASupplyBranchItem
class	OASupplyStraightItem
class	OASystemItem
class	OneFourStraightItem
class	OneThreeDualDuctItem
class	OneThreeDualDuctMixerItem
class	OneThreeNodeItem
class	OneThreeStraightItem
class	OneThreeWaterToAirItem
class	OneThreeWaterToWaterItem
class	OneTwoFourStraightItem
class	OneTwoStraightItem
class	OperableWindowVC
class	OSAppBase
class	OSCollapsibleItem
class	OSCollapsibleItemHeader
class	OSCollapsibleItemList
class	OSDocument
class	OSDropZone
class	OSDropZone2
class	OSDropZoneItem
class	OSInspectorView
class	OSItem
class	OSItemDropZone
class	OSItemId
class	OSItemList
class	OSItemSelector
class	OSItemSelectorButtons
class	OSVectorController
class	OtherEquipmentDefinitionInspectorView
class	OtherEquipmentScheduleVC
class	OverheadDoorConstructionVC
class	PeopleActivityScheduleVC
class	PeopleDefinitionInspectorView
class	PeopleInspectorView
class	PlanarSurfaceWidget
class	PlenumChooserView
class	RadianceDialog
class	RefrigerationCaseDetailView
class	RefrigerationCaseGridController
class	RefrigerationCasesDropZoneView
class	RefrigerationCasesView
class	RefrigerationCompressorDetailView
class	RefrigerationCompressorDropZoneView
class	RefrigerationCompressorView
class	RefrigerationCondenserView
class	RefrigerationController
class	RefrigerationGridController
class	RefrigerationGridView
class	RefrigerationHeatReclaimView
class	RefrigerationScene
class	RefrigerationSecondaryView
class	RefrigerationSHXView
class	RefrigerationSubCoolerView
class	RefrigerationSystemDetailView
class	RefrigerationSystemDropZoneView
class	RefrigerationSystemItemDelegate
class	RefrigerationSystemListController
class	RefrigerationSystemListDropZoneItem
class	RefrigerationSystemListItem
class	RefrigerationSystemMiniView
class	RefrigerationSystemView
class	RefrigerationView
class	RefrigerationWalkInGridController
class	RefrigerationWalkinInspectorView
class	RenderingColorWidget
class	RenderingColorWidget2
class	ResultsTabController
class	ResultsTabView
class	ResultsView
class	ResultsWebView
class	ReturnPlenumItem
class	ReverseVerticalBranchItem
class	RoofConstructionVC
class	RoofsTreeItem
class	RunItemView
class	RunListModel
class	RunTabController
class	RunTabView
class	RunView
class	ScheduleCalendarWidget
class	ScheduleDayEditor
class	ScheduleDayView
class	ScheduleDialog
class	ScheduledSPMView
class	ScheduleLimitsView
class	ScheduleRulesetInspectorView
class	ScheduleRulesetNameView
class	ScheduleRulesetNameWidget
class	ScheduleRuleView
class	ScheduleSetInspectorView
class	ScheduleSetsController
class	ScheduleSetsInspectorView
class	ScheduleSetsView
class	SchedulesTabController
class	SchedulesTabView
class	SchedulesView
class	ScheduleTab
class	ScheduleTabContent
class	ScheduleTabDefault
class	ScheduleTabHeader
class	ScheduleTabRule
class	ScheduleTypeLimitItem
class	ScriptFolderListView
class	ScriptItem
class	ScriptsListView
class	ScriptsTabController
class	ScriptsTabView
class	ScriptsVectorController
class	SecondaryDetailView
class	SecondaryDropZoneView
class	SensibleFractionScheduleVC
class	ServiceWaterItem
class	ServiceWaterScene
class	SewerItem
class	ShadingSurfaceGroupTreeItem
class	SimSettingsTabController
class	SimSettingsTabView
class	SimSettingsView
class	SingleZoneReheatSPMView
class	SiteShadingTreeItem
class	SiteShadingVC
class	SizingScheduleDayView
class	SkylightConstructionVC
class	SpaceLoadInstanceActivityScheduleVectorController
class	SpaceLoadInstanceDefinitionVectorController
class	SpaceLoadInstanceMiniView
class	SpaceLoadInstanceScheduleVectorController
class	SpaceLoadInstancesWidget
class	SpacesDaylightingGridController
class	SpacesDaylightingGridView
class	SpaceShadingTreeItem
class	SpaceShadingVC
class	SpacesInteriorPartitionsGridController
class	SpacesInteriorPartitionsGridView
class	SpacesLoadsGridController
class	SpacesLoadsGridView
class	SpacesShadingGridController
class	SpacesShadingGridView
class	SpacesSpacesGridController
class	SpacesSpacesGridView
class	SpacesSubsurfacesGridController
class	SpacesSubsurfacesGridView
class	SpacesSubtabGridView
class	SpacesSurfacesGridController
class	SpacesSurfacesGridView
class	SpacesTabController
class	SpacesTabView
class	SpaceTreeItem
class	SpaceTypeInspectorView
class	SpaceTypesController
class	SpaceTypesGridController
class	SpaceTypesGridView
class	SpaceTypesTabController
class	SpaceTypesTabView
class	SpaceTypesView
class	SpaceTypeTreeItem
class	SplitterItem
class	SplitterMixerInspectorView
class	StandardOpaqueMaterialInspectorView
class	StandardsInformationConstructionWidget
class	StandardsInformationMaterialWidget
class	SteamEquipmentDefinitionInspectorView
class	SteamEquipmentScheduleVC
class	SubTabController
class	SubTabView
class	SummaryTabController
class	SummaryTabView
class	SupplyAirTempScheduleVectorController
class	SupplyMixerItem
class	SupplyPlenumItem
class	SupplySideItem
class	SupplySplitterItem
class	SurfaceTreeItem
class	SystemAvailabilityVectorController
class	SystemCenterItem
class	SystemItem
class	TargetTemperatureScheduleVC
class	ThermalZoneInspectorView
class	ThermalZonesController
class	ThermalZonesGridController
class	ThermalZonesGridView
class	ThermalZonesTabController
class	ThermalZonesTabView
class	ThermalZonesView
class	ThermalZoneTreeItem
class	ThermalZoneView
class	ThreeFourStraightItem
class	TubularDaylightDiffuserConstructionVC
class	TubularDaylightDomeConstructionVC
class	TwoFiveNodeItem
class	TwoFourNodeItem
class	TwoFourStraightItem
class	TwoThreeFourStraightItem
class	TwoThreeStraightItem
class	TwoThreeStraightItem2
class	UtilityBillAllFuelTypesListView
class	UtilityBillFuelTypeItem
class	UtilityBillFuelTypeListController
class	UtilityBillFuelTypeListView
class	UtilityBillsController
class	UtilityBillsInspectorView
class	UtilityBillsView
class	VariableListItem
class	VariablesList
class	VariablesTabController
class	VariablesTabView
class	VCalendarSegmentItem
class	VerticalBranchItem
class	VerticalTabWidget
class	VRFController
class	VRFSystemDropZoneView
class	VRFSystemItemDelegate
class	VRFSystemListController
class	VRFSystemListDropZoneItem
class	VRFSystemListItem
class	VRFSystemMiniView
class	VRFSystemView
class	VRFTerminalView
class	VRFThermalZoneDropZoneView
class	VRFView
class	WallConstructionVC
class	WallsTreeItem
class	WaterHeaterHeatPumpInspectorView
class	WaterToAirInspectorView
class	WaterUseConnectionsDetailItem
class	WaterUseConnectionsDetailScene
class	WaterUseConnectionsDropZoneItem
class	WaterUseConnectionsItem
class	WaterUseEquipmentDefinitionInspectorView
class	WaterUseEquipmentDropZoneItem
class	WaterUseEquipmentItem
class	WindowMaterialBlindInspectorView
class	WindowMaterialDaylightRedirectionDeviceInspectorView
class	WindowMaterialGasInspectorView
class	WindowMaterialGasMixtureInspectorView
class	WindowMaterialGlazingGroupThermochromicInspectorView
class	WindowMaterialGlazingInspectorView
class	WindowMaterialGlazingRefractionExtinctionMethodInspectorView
class	WindowMaterialScreenInspectorView
class	WindowMaterialShadeInspectorView
class	WindowMaterialSimpleGlazingSystemInspectorView
class	YearOverview
class	YearSettingsWidget
class	ZoneChooserItem
class	ZoneChooserView
class	ZoneHVACBaseboardConvectiveWaterInspectorView
class	ZoneHVACBaseboardRadiantConvectiveWaterInspectorView
class	ZoneHVACFourPipeFanCoilInspectorView
class	ZoneHVACLowTempRadiantConstFlowInspectorView
class	ZoneHVACLowTempRadiantVarFlowInspectorView
class	ZoneHVACPackagedTerminalAirConditionerInspectorView
class	ZoneHVACPackagedTerminalHeatPumpInspectorView
class	ZoneHVACUnitHeaterInspectorView
class	ZoneHVACUnitVentilatorInspectorView
class	ZoneHVACWaterToAirHeatPumpInspectorView

Enumerations
enum	AddToModelEnum {   ADDTOMODEL_THERMALZONE, ADDTOMODEL_AIRLOOPHVAC, ADDTOMODEL_DUAL_AIRLOOPHVAC, ADDTOMODEL_SYSTEM_TYPE_1,   ADDTOMODEL_SYSTEM_TYPE_2, ADDTOMODEL_SYSTEM_TYPE_3, ADDTOMODEL_SYSTEM_TYPE_4, ADDTOMODEL_SYSTEM_TYPE_5,   ADDTOMODEL_SYSTEM_TYPE_6, ADDTOMODEL_SYSTEM_TYPE_7, ADDTOMODEL_SYSTEM_TYPE_8, ADDTOMODEL_SYSTEM_TYPE_9,   ADDTOMODEL_SYSTEM_TYPE_10, ADDTOMODEL_PLANTLOOP }
enum	BillFormat { STARTDATE_ENDDATE, STARTDATE_NUMDAYS, ENDDATE_NUMDAYS }
enum	NewFromTemplateEnum { NEWFROMTEMPLATE_EMPTY, NEWFROMTEMPLATE_WIZARD }

Functions
OPENSTUDIO_API bool	addReportingMeasureWorkItem (std::vector< runmanager::WorkItem > &workItems, const openstudio::BCLMeasure &bclMeasure)
OPENSTUDIO_API bool	addReportRequestMeasureWorkItem (std::vector< runmanager::WorkItem > &workItems, const openstudio::BCLMeasure &bclMeasure)
OSItemId	bclComponentToItemId (const BCLComponent &component)
OPENSTUDIO_API bool	copyDir (const QString &srcPath, const QString &dstPath)
OPENSTUDIO_API openstudio::path	createModelTempDir ()
	Create a temporary directory for an openstudio model This is where changes to the files, etc are staged. More...
OPENSTUDIO_API bool	findBCLMeasureWorkItem (const std::vector< runmanager::WorkItem > &workItems, const openstudio::UUID &uuid)
OPENSTUDIO_API bool	initializeModelTempDir (const openstudio::path &osmPath, const openstudio::path &modelTempDir)
	Copy existing model resources to temp dir. More...
OPENSTUDIO_API boost::optional < openstudio::model::Model >	modelFromIDF (const openstudio::path &path, openstudio::energyplus::ReverseTranslator &reverseTranslator, openstudio::ProgressBar *progressBar=nullptr)
OPENSTUDIO_API boost::optional < openstudio::model::Model >	modelFromOSM (const openstudio::path &path, openstudio::osversion::VersionTranslator &versionTranslator, openstudio::ProgressBar *progressBar=nullptr)
OSItemId	modelObjectToItemId (const openstudio::model::ModelObject &modelObject, bool isDefaulted)
QString	modelToSourceId (const openstudio::model::Model &model)
OPENSTUDIO_API void	pauseRunManager (openstudio::runmanager::RunManager &rm)
OPENSTUDIO_API bool	removeDir (const QString &dirName)
OPENSTUDIO_API void	removeModelTempDir (const openstudio::path &modelTempDir)
OPENSTUDIO_API openstudio::path	saveModel (openstudio::model::Model model, const openstudio::path &osmPath, const openstudio::path &modelTempDir)
OPENSTUDIO_API void	saveModelTempDir (const openstudio::path &modelTempDir, const openstudio::path &osmPath)
OPENSTUDIO_API bool	saveRunManagerDatabase (const openstudio::path &osmPath, const openstudio::path &modelTempDir, std::vector< double > useRadianceForDaylightingCalculations,*parent=nullptr)
OPENSTUDIO_API bool	saveRunManagerDatabase (const openstudio::path &osmPath, const openstudio::path &modelTempDir, const std::map< openstudio::path, std::vector< ruleset::UserScriptInfo > > &userScriptsByFolder, std::vector< double > useRadianceForDaylightingCalculations,*parent=nullptr)
OSItemId	scriptToItemId (const openstudio::path &t_path)
OPENSTUDIO_API void	startRunManager (openstudio::runmanager::RunManager &rm, const openstudio::path &osmPath, const openstudio::path &modelTempDir, std::vector< double > useRadianceForDaylightingCalculations, bool requireCalibrationReports,*parent=nullptr)
OPENSTUDIO_API bool	updateModelTempDir (openstudio::model::Model &model, const openstudio::path &modelTempDir)
	Update the model in the temp directory to include the correct directory structure, copy files to relative locations, etc Returns true if any changes were made. More...

Enumeration Type Documentation

enum openstudio::AddToModelEnum

Enumerator
ADDTOMODEL_THERMALZONE
ADDTOMODEL_AIRLOOPHVAC
ADDTOMODEL_DUAL_AIRLOOPHVAC
ADDTOMODEL_SYSTEM_TYPE_1
ADDTOMODEL_SYSTEM_TYPE_2
ADDTOMODEL_SYSTEM_TYPE_3
ADDTOMODEL_SYSTEM_TYPE_4
ADDTOMODEL_SYSTEM_TYPE_5
ADDTOMODEL_SYSTEM_TYPE_6
ADDTOMODEL_SYSTEM_TYPE_7
ADDTOMODEL_SYSTEM_TYPE_8
ADDTOMODEL_SYSTEM_TYPE_9
ADDTOMODEL_SYSTEM_TYPE_10
ADDTOMODEL_PLANTLOOP

enum openstudio::BillFormat

Enumerator
STARTDATE_ENDDATE
STARTDATE_NUMDAYS
ENDDATE_NUMDAYS

enum openstudio::NewFromTemplateEnum

Enumerator
NEWFROMTEMPLATE_EMPTY
NEWFROMTEMPLATE_WIZARD

Function Documentation

OPENSTUDIO_API bool openstudio::addReportingMeasureWorkItem	(	std::vector< runmanager::WorkItem > &	workItems,
		const openstudio::BCLMeasure &	bclMeasure
	)

OPENSTUDIO_API bool openstudio::addReportRequestMeasureWorkItem	(	std::vector< runmanager::WorkItem > &	workItems,
		const openstudio::BCLMeasure &	bclMeasure
	)

OSItemId openstudio::bclComponentToItemId

(

const BCLComponent &

component

)

OPENSTUDIO_API bool openstudio::copyDir	(	const QString &	srcPath,
		const QString &	dstPath
	)

OPENSTUDIO_API openstudio::path openstudio::createModelTempDir

(

)

Create a temporary directory for an openstudio model This is where changes to the files, etc are staged.

OPENSTUDIO_API bool openstudio::findBCLMeasureWorkItem	(	const std::vector< runmanager::WorkItem > &	workItems,
		const openstudio::UUID &	uuid
	)

OPENSTUDIO_API bool openstudio::initializeModelTempDir	(	const openstudio::path &	osmPath,
		const openstudio::path &	modelTempDir
	)

Copy existing model resources to temp dir.

OPENSTUDIO_API boost::optional<openstudio::model::Model> openstudio::modelFromIDF	(	const openstudio::path &	path,
		openstudio::energyplus::ReverseTranslator &	reverseTranslator,
		openstudio::ProgressBar *	progressBar = nullptr
	)

OPENSTUDIO_API boost::optional<openstudio::model::Model> openstudio::modelFromOSM	(	const openstudio::path &	path,
		openstudio::osversion::VersionTranslator &	versionTranslator,
		openstudio::ProgressBar *	progressBar = nullptr
	)

OSItemId openstudio::modelObjectToItemId	(	const openstudio::model::ModelObject &	modelObject,
		bool	isDefaulted
	)

QString openstudio::modelToSourceId

(

const openstudio::model::Model &

model

)

OPENSTUDIO_API void openstudio::pauseRunManager

(

openstudio::runmanager::RunManager &

rm

)

OPENSTUDIO_API bool openstudio::removeDir

(

const QString &

dirName

)

OPENSTUDIO_API void openstudio::removeModelTempDir

(

const openstudio::path &

modelTempDir

)

OPENSTUDIO_API openstudio::path openstudio::saveModel	(	openstudio::model::Model	model,
		const openstudio::path &	osmPath,
		const openstudio::path &	modelTempDir
	)

OPENSTUDIO_API void openstudio::saveModelTempDir	(	const openstudio::path &	modelTempDir,
		const openstudio::path &	osmPath
	)

OPENSTUDIO_API bool openstudio::saveRunManagerDatabase	(	const openstudio::path &	osmPath,
		const openstudio::path &	modelTempDir,
		std::vector< double >	useRadianceForDaylightingCalculations,
		*	parent = nullptr
	)

OPENSTUDIO_API bool openstudio::saveRunManagerDatabase	(	const openstudio::path &	osmPath,
		const openstudio::path &	modelTempDir,
		const std::map< openstudio::path, std::vector< ruleset::UserScriptInfo > > &	userScriptsByFolder,
		std::vector< double >	useRadianceForDaylightingCalculations,
		*	parent = nullptr
	)

OSItemId openstudio::scriptToItemId

(

const openstudio::path &

t_path

)

OPENSTUDIO_API void openstudio::startRunManager	(	openstudio::runmanager::RunManager &	rm,
		const openstudio::path &	osmPath,
		const openstudio::path &	modelTempDir,
		std::vector< double >	useRadianceForDaylightingCalculations,
		bool	requireCalibrationReports,
		*	parent = nullptr
	)

OPENSTUDIO_API bool openstudio::updateModelTempDir	(	openstudio::model::Model &	model,
		const openstudio::path &	modelTempDir
	)

Update the model in the temp directory to include the correct directory structure, copy files to relative locations, etc Returns true if any changes were made.