OpenStudioCore:energyplus
 All Classes Namespaces Functions Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
openstudio::energyplus::ForwardTranslator Class Reference

#include <ForwardTranslator.hpp>

Public Member Functions

std::vector< LogMessage > errors () const
 Get error messages generated by the last translation. More...
 
 ForwardTranslator ()
 
void setExcludeLCCObjects (bool excludeLCCObjects)
 If excludeLCCObjects, skip translation of life cycle cost objects. 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 setKeepRunControlSpecialDays (bool keepRunControlSpecialDays)
 Temporary code, use to preserve holidays in the model. More...
 
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...
 

Constructor & Destructor Documentation

openstudio::energyplus::ForwardTranslator::ForwardTranslator ( )

Member Function Documentation

std::vector<LogMessage> openstudio::energyplus::ForwardTranslator::errors ( ) const

Get error messages generated by the last translation.

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::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)

Temporary code, use to preserve 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.