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.
virtual	~SurfaceNetworkBuilder ()=default
	Destroy the translator.
Network Construction Functions
bool	build (model::Model &model)
Getters and Setters
ProgressBar *	progressBar () const
	Returns the progress bar currently associated with the object.
void	setProgressBar (ProgressBar *progressBar)
	Sets the progress bar to be updated by the object.

Miscellaneous Functions
virtual void	clear ()
	Clear any internally stored information in the builder object.
std::vector< LogMessage >	warnings () const
	Returns warning messages generated by the last translation.
std::vector< LogMessage >	errors () const
	Returns error messages generated by the last translation.
std::vector< LogMessage >	logMessages () const
	Returns error messages generated by the last translation.
void	progress ()
void	initProgress (int max, std::string label)
virtual bool	linkExteriorSurface (model::ThermalZone zone, model::Space space, model::Surface surface)
virtual bool	linkExteriorSubSurface (model::ThermalZone zone, model::Space space, model::Surface surface, model::SubSurface subSurface)
virtual bool	linkInteriorSurface (model::ThermalZone zone, model::Space space, model::Surface surface, model::Surface adjacentSurface, model::Space adjacentSpace, model::ThermalZone adjacentZone)
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)

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

SurfaceNetworkBuilder()

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

explicit

Construct a new object.

~SurfaceNetworkBuilder()

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

virtualdefault

Destroy the translator.

Member Function Documentation

build()

bool openstudio::airflow::SurfaceNetworkBuilder::build

(

model::Model &

model

)

clear()

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

inlinevirtual

Clear any internally stored information in the builder object.

errors()

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

(

)

const

Returns error messages generated by the last translation.

initProgress()

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

protected

linkExteriorSubSurface()

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

protectedvirtual

linkExteriorSurface()

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

protectedvirtual

linkInteriorSubSurface()

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

linkInteriorSurface()

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

logMessages()

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

(

)

const

Returns error messages generated by the last translation.

progress()

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

protected

progressBar()

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

(

)

const

Returns the progress bar currently associated with the object.

setProgressBar()

void openstudio::airflow::SurfaceNetworkBuilder::setProgressBar

(

ProgressBar *

progressBar

)

Sets the progress bar to be updated by the object.

warnings()

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

(

)

const

Returns warning messages generated by the last translation.