openstudio::OSDocument Class Reference

#include <OSDocument.hpp>

Inheritance diagram for openstudio::OSDocument:

Public Types
enum	HorizontalTabID { MY_MODEL, LIBRARY, EDIT }
enum	VerticalTabID {   SITE, SCHEDULES, CONSTRUCTIONS, LOADS,   SPACE_TYPES, FACILITY, SPACES, THERMAL_ZONES,   HVAC_SYSTEMS, BUILDING_SUMMARY, OUTPUT_VARIABLES, SIMULATION_SETTINGS,   RUBY_SCRIPTS, RUN_SIMULATION, RESULTS_SUMMARY }

Public Slots
void	closeSidebar ()
void	disableTabsDuringRun ()
void	enableTabsAfterRun ()
void	exportgbXML ()
void	exportIdf ()
void	exportSDD ()
void	markAsModified ()
void	markAsUnmodified ()
void	openBclDlg ()
void	openChangeMeasuresDirDlg ()
void	openMeasuresBclDlg ()
void	openMeasuresDlg ()
void	openSidebar ()
void	runComplete ()
bool	save ()
bool	saveAs ()
void	scanForTools ()
void	showRunManagerPreferences ()
void	weatherFileReset ()

Signals
void	aboutClicked ()
void	closeClicked ()
void	downloadComponentsClicked ()
void	enableRevertToSaved (bool enable)
void	exitClicked ()
void	helpClicked ()
void	importClicked ()
void	importgbXMLClicked ()
void	importIFCClicked ()
void	importSDDClicked ()
void	loadFileClicked ()
void	loadLibraryClicked ()
void	modelSaving (const openstudio::path &t_path)
void	newClicked ()
void	openLibDlgClicked ()
void	osmDropped (QString path)
void	toggleUnitsClicked (bool displayIP)
void	toolsUpdated ()
void	treeChanged (const openstudio::UUID &t_uuid)

Public Member Functions
openstudio::model::Model	combinedComponentLibrary () const
openstudio::model::Model	componentLibrary () const
bool	fromBCL (const OSItemId &itemId) const
bool	fromComponentLibrary (const OSItemId &itemId) const
bool	fromModel (const OSItemId &itemId) const
boost::optional< model::Component >	getComponent (const OSItemId &itemId) const
boost::optional< IddObjectType >	getIddObjectType (const OSItemId &itemId) const
boost::optional < model::ModelObject >	getModelObject (const OSItemId &itemId) const
openstudio::model::Model	hvacComponentLibrary () const
std::shared_ptr < MainRightColumnController >	mainRightColumnController () const
MainWindow *	mainWindow ()
model::Model	model ()
QString	modelTempDir () const
bool	modified () const
	OSDocument (openstudio::model::Model library, openstudio::model::Model hvacLibrary, const openstudio::path &resourcesPath, openstudio::model::OptionalModel model=boost::none, QString filePath=QString(), bool isPlugin=false, int startTabIndex=0, int startSubTabIndex=0)
boost::optional < analysisdriver::SimpleProject >	project () const
QString	savePath () const
void	setComponentLibrary (const openstudio::model::Model &model)
void	setHVACComponentLibrary (const openstudio::model::Model &model)
void	setModel (const model::Model &model, bool modified, bool saveCurrentTabs)
void	setWorkspace (const boost::optional< Workspace > &workspace)
int	subTabIndex ()
int	verticalTabIndex ()
boost::optional< Workspace >	workspace ()
virtual	~OSDocument ()

Public Attributes
boost::shared_ptr < ApplyMeasureNowDialog >	m_applyMeasureNowDialog

Member Enumeration Documentation

enum openstudio::OSDocument::HorizontalTabID

Enumerator
MY_MODEL
LIBRARY
EDIT

enum openstudio::OSDocument::VerticalTabID

Enumerator
SITE
SCHEDULES
CONSTRUCTIONS
LOADS
SPACE_TYPES
FACILITY
SPACES
THERMAL_ZONES
HVAC_SYSTEMS
BUILDING_SUMMARY
OUTPUT_VARIABLES
SIMULATION_SETTINGS
RUBY_SCRIPTS
RUN_SIMULATION
RESULTS_SUMMARY

Constructor & Destructor Documentation

openstudio::OSDocument::OSDocument	(	openstudio::model::Model	library,
		openstudio::model::Model	hvacLibrary,
		const openstudio::path &	resourcesPath,
		openstudio::model::OptionalModel	model = boost::none,
		QString	filePath = QString(),
		bool	isPlugin = false,
		int	startTabIndex = 0,
		int	startSubTabIndex = 0
	)

virtual openstudio::OSDocument::~OSDocument ( )

virtual

Member Function Documentation

void openstudio::OSDocument::aboutClicked ( )

signal

void openstudio::OSDocument::closeClicked ( )

signal

void openstudio::OSDocument::closeSidebar ( )

slot

openstudio::model::Model openstudio::OSDocument::combinedComponentLibrary

(

)

const

openstudio::model::Model openstudio::OSDocument::componentLibrary

(

)

const

void openstudio::OSDocument::disableTabsDuringRun ( )

slot

void openstudio::OSDocument::downloadComponentsClicked ( )

signal

void openstudio::OSDocument::enableRevertToSaved ( bool  enable )

signal

void openstudio::OSDocument::enableTabsAfterRun ( )

slot

void openstudio::OSDocument::exitClicked ( )

signal

void openstudio::OSDocument::exportgbXML ( )

slot

void openstudio::OSDocument::exportIdf ( )

slot

void openstudio::OSDocument::exportSDD ( )

slot

bool openstudio::OSDocument::fromBCL

(

const OSItemId &

itemId

)

const

bool openstudio::OSDocument::fromComponentLibrary

(

const OSItemId &

itemId

)

const

bool openstudio::OSDocument::fromModel

(

const OSItemId &

itemId

)

const

boost::optional<model::Component> openstudio::OSDocument::getComponent

(

const OSItemId &

itemId

)

const

boost::optional<IddObjectType> openstudio::OSDocument::getIddObjectType

(

const OSItemId &

itemId

)

const

boost::optional<model::ModelObject> openstudio::OSDocument::getModelObject

(

const OSItemId &

itemId

)

const

void openstudio::OSDocument::helpClicked ( )

signal

openstudio::model::Model openstudio::OSDocument::hvacComponentLibrary

(

)

const

void openstudio::OSDocument::importClicked ( )

signal

void openstudio::OSDocument::importgbXMLClicked ( )

signal

void openstudio::OSDocument::importIFCClicked ( )

signal

void openstudio::OSDocument::importSDDClicked ( )

signal

void openstudio::OSDocument::loadFileClicked ( )

signal

void openstudio::OSDocument::loadLibraryClicked ( )

signal

std::shared_ptr<MainRightColumnController> openstudio::OSDocument::mainRightColumnController

(

)

const

MainWindow* openstudio::OSDocument::mainWindow

(

)

void openstudio::OSDocument::markAsModified ( )

slot

void openstudio::OSDocument::markAsUnmodified ( )

slot

model::Model openstudio::OSDocument::model

(

)

void openstudio::OSDocument::modelSaving ( const openstudio::path &  t_path )

signal

QString openstudio::OSDocument::modelTempDir

(

)

const

bool openstudio::OSDocument::modified

(

)

const

void openstudio::OSDocument::newClicked ( )

signal

void openstudio::OSDocument::openBclDlg ( )

slot

void openstudio::OSDocument::openChangeMeasuresDirDlg ( )

slot

void openstudio::OSDocument::openLibDlgClicked ( )

signal

void openstudio::OSDocument::openMeasuresBclDlg ( )

slot

void openstudio::OSDocument::openMeasuresDlg ( )

slot

void openstudio::OSDocument::openSidebar ( )

slot

void openstudio::OSDocument::osmDropped ( QString  path )

signal

boost::optional<analysisdriver::SimpleProject> openstudio::OSDocument::project

(

)

const

void openstudio::OSDocument::runComplete ( )

slot

bool openstudio::OSDocument::save ( )

slot

bool openstudio::OSDocument::saveAs ( )

slot

QString openstudio::OSDocument::savePath

(

)

const

void openstudio::OSDocument::scanForTools ( )

slot

void openstudio::OSDocument::setComponentLibrary

(

const openstudio::model::Model &

model

)

void openstudio::OSDocument::setHVACComponentLibrary

(

const openstudio::model::Model &

model

)

void openstudio::OSDocument::setModel	(	const model::Model &	model,
		bool	modified,
		bool	saveCurrentTabs
	)

void openstudio::OSDocument::setWorkspace

(

const boost::optional< Workspace > &

workspace

)

void openstudio::OSDocument::showRunManagerPreferences ( )

slot

int openstudio::OSDocument::subTabIndex

(

)

void openstudio::OSDocument::toggleUnitsClicked ( bool  displayIP )

signal

void openstudio::OSDocument::toolsUpdated ( )

signal

void openstudio::OSDocument::treeChanged ( const openstudio::UUID &  t_uuid )

signal

int openstudio::OSDocument::verticalTabIndex

(

)

void openstudio::OSDocument::weatherFileReset ( )

slot

boost::optional<Workspace> openstudio::OSDocument::workspace

(

)

Member Data Documentation

boost::shared_ptr<ApplyMeasureNowDialog> openstudio::OSDocument::m_applyMeasureNowDialog