openstudio::airflow::SurfaceNetworkBuilder Class Reference

#include <SurfaceNetworkBuilder.hpp>

Inheritance diagram for openstudio::airflow::SurfaceNetworkBuilder:

Public Member Functions
Constructors and Destructors
	SurfaceNetworkBuilder (ProgressBar *progressBar=nullptr)
	Construct a new object. More...
virtual	~SurfaceNetworkBuilder ()=default
	Destroy the translator. More...
Network Construction Functions
bool	build (model::Model &model)
Getters and Setters
ProgressBar *	progressBar () const
	Returns the progress bar currently associated with the object. More...
void	setProgressBar (ProgressBar *progressBar)
	Sets the progress bar to be updated by the object. More...
Miscellaneous Functions
virtual void	clear ()
	Clear any internally stored information in the builder object. More...
std::vector< LogMessage >	warnings () const
	Returns warning messages generated by the last translation. More...
std::vector< LogMessage >	errors () const
	Returns error messages generated by the last translation. More...
std::vector< LogMessage >	logMessages () const
	Returns error messages generated by the last translation. More...

Protected Member Functions
void	initProgress (int max, std::string label)
virtual bool	linkExteriorSubSurface (model::ThermalZone zone, model::Space space, model::Surface surface, model::SubSurface subSurface)
virtual bool	linkExteriorSurface (model::ThermalZone zone, model::Space space, model::Surface surface)
virtual bool	linkInteriorSubSurface (model::ThermalZone zone, model::Space space, model::Surface surface, model::SubSurface subSurface, model::SubSurface adjacentSubSurface, model::Surface adjacentSurface, model::Space adjacentSpace, model::ThermalZone adjacentZone)
virtual bool	linkInteriorSurface (model::ThermalZone zone, model::Space space, model::Surface surface, model::Surface adjacentSurface, model::Space adjacentSpace, model::ThermalZone adjacentZone)
void	progress ()

Detailed Description

SurfaceNetworkBuilder objects walk the OpenStudio model as a network of surfaces.

The SurfaceNetworkBuilder object walks the OpenStudio model as a network of surface, calling a different function once for each pair of interior surfaces or subsurfaces and once for each exterior surface or subsurface. The intended usage is to subclass for a specific application.

Constructor & Destructor Documentation

openstudio::airflow::SurfaceNetworkBuilder::SurfaceNetworkBuilder ( ProgressBar *  progressBar = nullptr )

explicit

Construct a new object.

virtual openstudio::airflow::SurfaceNetworkBuilder::~SurfaceNetworkBuilder ( )

virtualdefault

Destroy the translator.

Member Function Documentation

bool openstudio::airflow::SurfaceNetworkBuilder::build

(

model::Model &

model

)

virtual void openstudio::airflow::SurfaceNetworkBuilder::clear ( )

inlinevirtual

Clear any internally stored information in the builder object.

std::vector<LogMessage> openstudio::airflow::SurfaceNetworkBuilder::errors

(

)

const

Returns error messages generated by the last translation.

void openstudio::airflow::SurfaceNetworkBuilder::initProgress ( int  max, std::string  label  )

protected

virtual bool openstudio::airflow::SurfaceNetworkBuilder::linkExteriorSubSurface ( model::ThermalZone  zone, model::Space  space, model::Surface  surface, model::SubSurface  subSurface  )

protectedvirtual

virtual bool openstudio::airflow::SurfaceNetworkBuilder::linkExteriorSurface ( model::ThermalZone  zone, model::Space  space, model::Surface  surface  )

protectedvirtual

virtual bool openstudio::airflow::SurfaceNetworkBuilder::linkInteriorSubSurface ( model::ThermalZone  zone, model::Space  space, model::Surface  surface, model::SubSurface  subSurface, model::SubSurface  adjacentSubSurface, model::Surface  adjacentSurface, model::Space  adjacentSpace, model::ThermalZone  adjacentZone  )

protectedvirtual

virtual bool openstudio::airflow::SurfaceNetworkBuilder::linkInteriorSurface ( model::ThermalZone  zone, model::Space  space, model::Surface  surface, model::Surface  adjacentSurface, model::Space  adjacentSpace, model::ThermalZone  adjacentZone  )

protectedvirtual

std::vector<LogMessage> openstudio::airflow::SurfaceNetworkBuilder::logMessages

(

)

const

Returns error messages generated by the last translation.

void openstudio::airflow::SurfaceNetworkBuilder::progress ( )

protected

ProgressBar* openstudio::airflow::SurfaceNetworkBuilder::progressBar

(

)

const

Returns the progress bar currently associated with the object.

void openstudio::airflow::SurfaceNetworkBuilder::setProgressBar

(

ProgressBar *

progressBar

)

Sets the progress bar to be updated by the object.

std::vector<LogMessage> openstudio::airflow::SurfaceNetworkBuilder::warnings

(

)

const

Returns warning messages generated by the last translation.