openstudio::energyplus::ForwardTranslator Class Reference

#include <ForwardTranslator.hpp>

Public Member Functions
std::vector< LogMessage >	errors () const
	Get error messages generated by the last translation.
	ForwardTranslator ()
ForwardTranslatorOptions	forwardTranslatorOptions () const
void	setExcludeHTMLOutputReport (bool excludeHTMLOutputReport)
	If excludeHTMLOutputReport, do not include the Output:Table:SummaryReports object.
void	setExcludeLCCObjects (bool excludeLCCObjects)
	If excludeLCCObjects, skip translation of life cycle cost objects.
void	setExcludeSpaceTranslation (bool excludeSpaceTranslation)
	If excludeSpaceTranslation, do usual combineSpaces(), etc.
void	setExcludeSQliteOutputReport (bool excludeSQliteOutputReport)
	If excludeSQliteOutputReport, do not include the Output:Sqlite object.
void	setExcludeVariableDictionary (bool excludeVariableDictionary)
	If excludeVariableDictionary, do not include the Output:VariableDictionary object.
void	setForwardTranslatorOptions (ForwardTranslatorOptions forwardTranslatorOptions)
void	setIPTabularOutput (bool isIP)
	If isIP, translate to a Workspace that requests Inch Pound tabular (HTML) reports from EnergyPlus Use this interface with extreme caution and understanding of the impacts of reporting IP units.
void	setKeepRunControlSpecialDays (bool keepRunControlSpecialDays)
	@Convenience methods for ForwardTranslatorOptions (and for backward compatibility)
Workspace	translateModel (const model::Model &model, ProgressBar *progressBar=nullptr)
	Translates the given Model to a Workspace.
Workspace	translateModelObject (model::ModelObject &modelObject)
	Translates a ModelObject into a Workspace.
std::vector< LogMessage >	warnings () const
	Get warning messages generated by the last translation.

Constructor & Destructor Documentation

ForwardTranslator()

openstudio::energyplus::ForwardTranslator::ForwardTranslator

(

)

Member Function Documentation

errors()

std::vector< LogMessage > openstudio::energyplus::ForwardTranslator::errors

(

)

const

Get error messages generated by the last translation.

forwardTranslatorOptions()

ForwardTranslatorOptions openstudio::energyplus::ForwardTranslator::forwardTranslatorOptions

(

)

const

setExcludeHTMLOutputReport()

void openstudio::energyplus::ForwardTranslator::setExcludeHTMLOutputReport

(

bool

excludeHTMLOutputReport

)

If excludeHTMLOutputReport, do not include the Output:Table:SummaryReports object.

Use this at your own risks

setExcludeLCCObjects()

void openstudio::energyplus::ForwardTranslator::setExcludeLCCObjects

(

bool

excludeLCCObjects

)

If excludeLCCObjects, skip translation of life cycle cost objects.

Use this interface with extreme caution and understanding of the impacts. Some assumptions in OpenStudio will fail if you exclude life cycle costs

setExcludeSpaceTranslation()

void openstudio::energyplus::ForwardTranslator::setExcludeSpaceTranslation

(

bool

excludeSpaceTranslation

)

If excludeSpaceTranslation, do usual combineSpaces(), etc.

Otherwise, translate space objects. Use this at your own risks

setExcludeSQliteOutputReport()

void openstudio::energyplus::ForwardTranslator::setExcludeSQliteOutputReport

(

bool

excludeSQliteOutputReport

)

If excludeSQliteOutputReport, do not include the Output:Sqlite object.

Use this at your own risks

setExcludeVariableDictionary()

void openstudio::energyplus::ForwardTranslator::setExcludeVariableDictionary

(

bool

excludeVariableDictionary

)

If excludeVariableDictionary, do not include the Output:VariableDictionary object.

Use this at your own risks

setForwardTranslatorOptions()

void openstudio::energyplus::ForwardTranslator::setForwardTranslatorOptions

(

ForwardTranslatorOptions

forwardTranslatorOptions

)

setIPTabularOutput()

void openstudio::energyplus::ForwardTranslator::setIPTabularOutput

(

bool

isIP

)

If isIP, translate to a Workspace that requests Inch Pound tabular (HTML) reports from EnergyPlus Use this interface with extreme caution and understanding of the impacts of reporting IP units.

Some assumptions in OpenStudio results processing may fail.

setKeepRunControlSpecialDays()

void openstudio::energyplus::ForwardTranslator::setKeepRunControlSpecialDays

(

bool

keepRunControlSpecialDays

)

@Convenience methods for ForwardTranslatorOptions (and for backward compatibility)

keepRunControlSpecialDays is enabled by default. You can use this method to NOT translate the holidays in the model.

translateModel()

Workspace openstudio::energyplus::ForwardTranslator::translateModel	(	const model::Model &	model,
		ProgressBar *	progressBar = nullptr )

Translates the given Model to a Workspace.

translateModelObject()

Workspace openstudio::energyplus::ForwardTranslator::translateModelObject

(

model::ModelObject &

modelObject

)

Translates a ModelObject into a Workspace.

warnings()

std::vector< LogMessage > openstudio::energyplus::ForwardTranslator::warnings

(

)

const

Get warning messages generated by the last translation.