 |
OpenStudio:energyplus |
#include <ForwardTranslator.hpp>
Public Member Functions | |
| std::vector< LogMessage > | errors () const |
| Get error messages generated by the last translation. More... | |
| ForwardTranslator () | |
| ForwardTranslatorOptions | forwardTranslatorOptions () const |
| void | setForwardTranslatorOptions (ForwardTranslatorOptions forwardTranslatorOptions) |
| Workspace | translateModel (const model::Model &model, ProgressBar *progressBar=nullptr) |
| Translates the given Model to a Workspace. More... | |
| Workspace | translateModelObject (model::ModelObject &modelObject) |
| Translates a ModelObject into a Workspace. More... | |
| std::vector< LogMessage > | warnings () const |
| Get warning messages generated by the last translation. More... | |
| void | setKeepRunControlSpecialDays (bool keepRunControlSpecialDays) |
| methods for ForwardTranslatorOptions (and for backward compatibility) More... | |
| 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. More... | |
| void | setExcludeLCCObjects (bool excludeLCCObjects) |
| If excludeLCCObjects, skip translation of life cycle cost objects. More... | |
| void | setExcludeSQliteOutputReport (bool excludeSQliteOutputReport) |
| If excludeSQliteOutputReport, do not include the Output:Sqlite object. More... | |
| void | setExcludeHTMLOutputReport (bool excludeHTMLOutputReport) |
| If excludeHTMLOutputReport, do not include the Output:Table:SummaryReports object. More... | |
| void | setExcludeVariableDictionary (bool excludeVariableDictionary) |
| If excludeVariableDictionary, do not include the Output:VariableDictionary object. More... | |
| void | setExcludeSpaceTranslation (bool excludeSpaceTranslation) |
| If excludeSpaceTranslation, do usual combineSpaces(), etc. More... | |
| openstudio::energyplus::ForwardTranslator::ForwardTranslator | ( | ) |
| std::vector<LogMessage> openstudio::energyplus::ForwardTranslator::errors | ( | ) | const |
Get error messages generated by the last translation.
| ForwardTranslatorOptions openstudio::energyplus::ForwardTranslator::forwardTranslatorOptions | ( | ) | const |
| void openstudio::energyplus::ForwardTranslator::setExcludeHTMLOutputReport | ( | bool | excludeHTMLOutputReport | ) |
If excludeHTMLOutputReport, do not include the Output:Table:SummaryReports object.
Use this at your own risks
| 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
| void openstudio::energyplus::ForwardTranslator::setExcludeSpaceTranslation | ( | bool | excludeSpaceTranslation | ) |
If excludeSpaceTranslation, do usual combineSpaces(), etc.
Otherwise, translate space objects. Use this at your own risks
| void openstudio::energyplus::ForwardTranslator::setExcludeSQliteOutputReport | ( | bool | excludeSQliteOutputReport | ) |
If excludeSQliteOutputReport, do not include the Output:Sqlite object.
Use this at your own risks
| void openstudio::energyplus::ForwardTranslator::setExcludeVariableDictionary | ( | bool | excludeVariableDictionary | ) |
If excludeVariableDictionary, do not include the Output:VariableDictionary object.
Use this at your own risks
| void openstudio::energyplus::ForwardTranslator::setForwardTranslatorOptions | ( | ForwardTranslatorOptions | forwardTranslatorOptions | ) |
| 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.
| void openstudio::energyplus::ForwardTranslator::setKeepRunControlSpecialDays | ( | bool | keepRunControlSpecialDays | ) |
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.
| Workspace openstudio::energyplus::ForwardTranslator::translateModel | ( | const model::Model & | model, |
| ProgressBar * | progressBar = nullptr |
||
| ) |
Translates the given Model to a Workspace.
| Workspace openstudio::energyplus::ForwardTranslator::translateModelObject | ( | model::ModelObject & | modelObject | ) |
Translates a ModelObject into a Workspace.
| std::vector<LogMessage> openstudio::energyplus::ForwardTranslator::warnings | ( | ) | const |
Get warning messages generated by the last translation.