openstudio::ThreeUserData Class Reference

#include <ThreeJS.hpp>

Public Member Functions
void	addAirLoopHVACHandle (const std::string &s)
void	addAirLoopHVACMaterialName (const std::string &s)
void	addAirLoopHVACName (const std::string &s)
std::vector< std::string >	airLoopHVACHandles () const
std::vector< std::string >	airLoopHVACMaterialNames () const
std::vector< std::string >	airLoopHVACNames () const
bool	airWall () const
std::string	boundaryMaterialName () const
std::string	buildingStoryHandle () const
std::string	buildingStoryMaterialName () const
std::string	buildingStoryName () const
	BuildingStory name if any.
std::string	buildingUnitHandle () const
std::string	buildingUnitMaterialName () const
std::string	buildingUnitName () const
	BuildingUnit name if any.
bool	coincidentWithOutsideObject () const
std::string	constructionHandle () const
std::string	constructionMaterialName () const
std::string	constructionName () const
	Construction name if any.
std::string	constructionSetHandle () const
std::string	constructionSetMaterialName () const
std::string	constructionSetName () const
	ConstructionSet name if any.
bool	convex () const
bool	correctlyOriented () const
std::string	handle () const
double	illuminanceSetpoint () const
bool	includeGeometryDiagnostics () const
std::string	name () const
std::string	outsideBoundaryCondition () const
std::string	outsideBoundaryConditionObjectHandle () const
std::string	outsideBoundaryConditionObjectName () const
void	setAirWall (bool b)
void	setBoundaryMaterialName (const std::string &s)
void	setBuildingStoryHandle (const std::string &s)
void	setBuildingStoryMaterialName (const std::string &s)
void	setBuildingStoryName (const std::string &s)
void	setBuildingUnitHandle (const std::string &s)
void	setBuildingUnitMaterialName (const std::string &s)
void	setBuildingUnitName (const std::string &s)
void	setCoincidentWithOutsideObject (bool b)
void	setConstructionHandle (const std::string &s)
void	setConstructionMaterialName (const std::string &s)
void	setConstructionName (const std::string &s)
void	setConstructionSetHandle (const std::string &s)
void	setConstructionSetMaterialName (const std::string &s)
void	setConstructionSetName (const std::string &s)
void	setConvex (bool b)
void	setCorrectlyOriented (bool b)
void	setHandle (const std::string &s)
void	setIlluminanceSetpoint (double d)
void	setIncludeGeometryDiagnostics (bool includeGeometryDiagnostics)
void	setName (const std::string &s)
void	setOutsideBoundaryCondition (const std::string &s)
void	setOutsideBoundaryConditionObjectHandle (const std::string &s)
void	setOutsideBoundaryConditionObjectName (const std::string &s)
void	setShadingHandle (const std::string &s)
void	setShadingName (const std::string &s)
void	setSpaceConvex (bool b)
void	setSpaceEnclosed (bool b)
void	setSpaceHandle (const std::string &s)
void	setSpaceName (const std::string &s)
void	setSpaceTypeHandle (const std::string &s)
void	setSpaceTypeMaterialName (const std::string &s)
void	setSpaceTypeName (const std::string &s)
void	setSubSurfaceHandle (const std::string &s)
void	setSubSurfaceName (const std::string &s)
void	setSunExposure (const std::string &s)
void	setSurfaceHandle (const std::string &s)
void	setSurfaceName (const std::string &s)
void	setSurfaceType (const std::string &s)
void	setSurfaceTypeMaterialName (const std::string &s)
void	setThermalZoneHandle (const std::string &s)
void	setThermalZoneMaterialName (const std::string &s)
void	setThermalZoneName (const std::string &s)
void	setWindExposure (const std::string &s)
std::string	shadingHandle () const
std::string	shadingName () const
	Parent shading name if any.
bool	spaceConvex () const
bool	spaceEnclosed () const
std::string	spaceHandle () const
std::string	spaceName () const
	Parent spaces name if any.
std::string	spaceTypeHandle () const
std::string	spaceTypeMaterialName () const
std::string	spaceTypeName () const
	SpaceType name if any.
std::string	subSurfaceHandle () const
std::string	subSurfaceName () const
	Parent sub surface name if any.
std::string	sunExposure () const
std::string	surfaceHandle () const
std::string	surfaceName () const
	Parent surface name if any.
std::string	surfaceType () const
	surfaceType is overloaded as a more general type: Surfaces {"Wall", "Floor", "RoofCeiling"} SubSurfaces {"FixedWindow", "OperableWindow", "GlassDoor", "Skylight", "TubularDaylightDome", "TubularDaylightDiffuser", "Door", "OverheadDoor"} ShadingSurfaces {"SiteShading", "BuildingShading", "SpaceShading"} InteriorPartitionSurfaces {"InteriorPartitionSurface"} DaylightingControl {"DaylightingControl"}
std::string	surfaceTypeMaterialName () const
std::string	thermalZoneHandle () const
std::string	thermalZoneMaterialName () const
std::string	thermalZoneName () const
	ThermalZone name if any.
	ThreeUserData ()
std::string	windExposure () const

Detailed Description

ThreeUserData decorates a ThreeSceneChild with additional information.

Constructor & Destructor Documentation

ThreeUserData()

openstudio::ThreeUserData::ThreeUserData

(

)

Member Function Documentation

addAirLoopHVACHandle()

void openstudio::ThreeUserData::addAirLoopHVACHandle

(

const std::string &

s

)

addAirLoopHVACMaterialName()

void openstudio::ThreeUserData::addAirLoopHVACMaterialName

(

const std::string &

s

)

addAirLoopHVACName()

void openstudio::ThreeUserData::addAirLoopHVACName

(

const std::string &

s

)

airLoopHVACHandles()

std::vector< std::string > openstudio::ThreeUserData::airLoopHVACHandles

(

)

const

airLoopHVACMaterialNames()

std::vector< std::string > openstudio::ThreeUserData::airLoopHVACMaterialNames

(

)

const

airLoopHVACNames()

std::vector< std::string > openstudio::ThreeUserData::airLoopHVACNames

(

)

const

airWall()

bool openstudio::ThreeUserData::airWall

(

)

const

boundaryMaterialName()

std::string openstudio::ThreeUserData::boundaryMaterialName

(

)

const

buildingStoryHandle()

std::string openstudio::ThreeUserData::buildingStoryHandle

(

)

const

buildingStoryMaterialName()

std::string openstudio::ThreeUserData::buildingStoryMaterialName

(

)

const

buildingStoryName()

std::string openstudio::ThreeUserData::buildingStoryName

(

)

const

BuildingStory name if any.

buildingUnitHandle()

std::string openstudio::ThreeUserData::buildingUnitHandle

(

)

const

buildingUnitMaterialName()

std::string openstudio::ThreeUserData::buildingUnitMaterialName

(

)

const

buildingUnitName()

std::string openstudio::ThreeUserData::buildingUnitName

(

)

const

BuildingUnit name if any.

coincidentWithOutsideObject()

bool openstudio::ThreeUserData::coincidentWithOutsideObject

(

)

const

constructionHandle()

std::string openstudio::ThreeUserData::constructionHandle

(

)

const

constructionMaterialName()

std::string openstudio::ThreeUserData::constructionMaterialName

(

)

const

constructionName()

std::string openstudio::ThreeUserData::constructionName

(

)

const

Construction name if any.

constructionSetHandle()

std::string openstudio::ThreeUserData::constructionSetHandle

(

)

const

constructionSetMaterialName()

std::string openstudio::ThreeUserData::constructionSetMaterialName

(

)

const

constructionSetName()

std::string openstudio::ThreeUserData::constructionSetName

(

)

const

ConstructionSet name if any.

convex()

bool openstudio::ThreeUserData::convex

(

)

const

correctlyOriented()

bool openstudio::ThreeUserData::correctlyOriented

(

)

const

handle()

std::string openstudio::ThreeUserData::handle

(

)

const

illuminanceSetpoint()

double openstudio::ThreeUserData::illuminanceSetpoint

(

)

const

includeGeometryDiagnostics()

bool openstudio::ThreeUserData::includeGeometryDiagnostics

(

)

const

name()

std::string openstudio::ThreeUserData::name

(

)

const

outsideBoundaryCondition()

std::string openstudio::ThreeUserData::outsideBoundaryCondition

(

)

const

outsideBoundaryConditionObjectHandle()

std::string openstudio::ThreeUserData::outsideBoundaryConditionObjectHandle

(

)

const

outsideBoundaryConditionObjectName()

std::string openstudio::ThreeUserData::outsideBoundaryConditionObjectName

(

)

const

setAirWall()

void openstudio::ThreeUserData::setAirWall

(

bool

b

)

setBoundaryMaterialName()

void openstudio::ThreeUserData::setBoundaryMaterialName

(

const std::string &

s

)

setBuildingStoryHandle()

void openstudio::ThreeUserData::setBuildingStoryHandle

(

const std::string &

s

)

setBuildingStoryMaterialName()

void openstudio::ThreeUserData::setBuildingStoryMaterialName

(

const std::string &

s

)

setBuildingStoryName()

void openstudio::ThreeUserData::setBuildingStoryName

(

const std::string &

s

)

setBuildingUnitHandle()

void openstudio::ThreeUserData::setBuildingUnitHandle

(

const std::string &

s

)

setBuildingUnitMaterialName()

void openstudio::ThreeUserData::setBuildingUnitMaterialName

(

const std::string &

s

)

setBuildingUnitName()

void openstudio::ThreeUserData::setBuildingUnitName

(

const std::string &

s

)

setCoincidentWithOutsideObject()

void openstudio::ThreeUserData::setCoincidentWithOutsideObject

(

bool

b

)

setConstructionHandle()

void openstudio::ThreeUserData::setConstructionHandle

(

const std::string &

s

)

setConstructionMaterialName()

void openstudio::ThreeUserData::setConstructionMaterialName

(

const std::string &

s

)

setConstructionName()

void openstudio::ThreeUserData::setConstructionName

(

const std::string &

s

)

setConstructionSetHandle()

void openstudio::ThreeUserData::setConstructionSetHandle

(

const std::string &

s

)

setConstructionSetMaterialName()

void openstudio::ThreeUserData::setConstructionSetMaterialName

(

const std::string &

s

)

setConstructionSetName()

void openstudio::ThreeUserData::setConstructionSetName

(

const std::string &

s

)

setConvex()

void openstudio::ThreeUserData::setConvex

(

bool

b

)

setCorrectlyOriented()

void openstudio::ThreeUserData::setCorrectlyOriented

(

bool

b

)

setHandle()

void openstudio::ThreeUserData::setHandle

(

const std::string &

s

)

setIlluminanceSetpoint()

void openstudio::ThreeUserData::setIlluminanceSetpoint

(

double

d

)

setIncludeGeometryDiagnostics()

void openstudio::ThreeUserData::setIncludeGeometryDiagnostics

(

bool

includeGeometryDiagnostics

)

setName()

void openstudio::ThreeUserData::setName

(

const std::string &

s

)

setOutsideBoundaryCondition()

void openstudio::ThreeUserData::setOutsideBoundaryCondition

(

const std::string &

s

)

setOutsideBoundaryConditionObjectHandle()

void openstudio::ThreeUserData::setOutsideBoundaryConditionObjectHandle

(

const std::string &

s

)

setOutsideBoundaryConditionObjectName()

void openstudio::ThreeUserData::setOutsideBoundaryConditionObjectName

(

const std::string &

s

)

setShadingHandle()

void openstudio::ThreeUserData::setShadingHandle

(

const std::string &

s

)

setShadingName()

void openstudio::ThreeUserData::setShadingName

(

const std::string &

s

)

setSpaceConvex()

void openstudio::ThreeUserData::setSpaceConvex

(

bool

b

)

setSpaceEnclosed()

void openstudio::ThreeUserData::setSpaceEnclosed

(

bool

b

)

setSpaceHandle()

void openstudio::ThreeUserData::setSpaceHandle

(

const std::string &

s

)

setSpaceName()

void openstudio::ThreeUserData::setSpaceName

(

const std::string &

s

)

setSpaceTypeHandle()

void openstudio::ThreeUserData::setSpaceTypeHandle

(

const std::string &

s

)

setSpaceTypeMaterialName()

void openstudio::ThreeUserData::setSpaceTypeMaterialName

(

const std::string &

s

)

setSpaceTypeName()

void openstudio::ThreeUserData::setSpaceTypeName

(

const std::string &

s

)

setSubSurfaceHandle()

void openstudio::ThreeUserData::setSubSurfaceHandle

(

const std::string &

s

)

setSubSurfaceName()

void openstudio::ThreeUserData::setSubSurfaceName

(

const std::string &

s

)

setSunExposure()

void openstudio::ThreeUserData::setSunExposure

(

const std::string &

s

)

setSurfaceHandle()

void openstudio::ThreeUserData::setSurfaceHandle

(

const std::string &

s

)

setSurfaceName()

void openstudio::ThreeUserData::setSurfaceName

(

const std::string &

s

)

setSurfaceType()

void openstudio::ThreeUserData::setSurfaceType

(

const std::string &

s

)

setSurfaceTypeMaterialName()

void openstudio::ThreeUserData::setSurfaceTypeMaterialName

(

const std::string &

s

)

setThermalZoneHandle()

void openstudio::ThreeUserData::setThermalZoneHandle

(

const std::string &

s

)

setThermalZoneMaterialName()

void openstudio::ThreeUserData::setThermalZoneMaterialName

(

const std::string &

s

)

setThermalZoneName()

void openstudio::ThreeUserData::setThermalZoneName

(

const std::string &

s

)

setWindExposure()

void openstudio::ThreeUserData::setWindExposure

(

const std::string &

s

)

shadingHandle()

std::string openstudio::ThreeUserData::shadingHandle

(

)

const

shadingName()

std::string openstudio::ThreeUserData::shadingName

(

)

const

Parent shading name if any.

spaceConvex()

bool openstudio::ThreeUserData::spaceConvex

(

)

const

spaceEnclosed()

bool openstudio::ThreeUserData::spaceEnclosed

(

)

const

spaceHandle()

std::string openstudio::ThreeUserData::spaceHandle

(

)

const

spaceName()

std::string openstudio::ThreeUserData::spaceName

(

)

const

Parent spaces name if any.

spaceTypeHandle()

std::string openstudio::ThreeUserData::spaceTypeHandle

(

)

const

spaceTypeMaterialName()

std::string openstudio::ThreeUserData::spaceTypeMaterialName

(

)

const

spaceTypeName()

std::string openstudio::ThreeUserData::spaceTypeName

(

)

const

SpaceType name if any.

subSurfaceHandle()

std::string openstudio::ThreeUserData::subSurfaceHandle

(

)

const

subSurfaceName()

std::string openstudio::ThreeUserData::subSurfaceName

(

)

const

Parent sub surface name if any.

sunExposure()

std::string openstudio::ThreeUserData::sunExposure

(

)

const

surfaceHandle()

std::string openstudio::ThreeUserData::surfaceHandle

(

)

const

surfaceName()

std::string openstudio::ThreeUserData::surfaceName

(

)

const

Parent surface name if any.

surfaceType()

std::string openstudio::ThreeUserData::surfaceType

(

)

const

surfaceType is overloaded as a more general type: Surfaces {"Wall", "Floor", "RoofCeiling"} SubSurfaces {"FixedWindow", "OperableWindow", "GlassDoor", "Skylight", "TubularDaylightDome", "TubularDaylightDiffuser", "Door", "OverheadDoor"} ShadingSurfaces {"SiteShading", "BuildingShading", "SpaceShading"} InteriorPartitionSurfaces {"InteriorPartitionSurface"} DaylightingControl {"DaylightingControl"}

surfaceTypeMaterialName()

std::string openstudio::ThreeUserData::surfaceTypeMaterialName

(

)

const

thermalZoneHandle()

std::string openstudio::ThreeUserData::thermalZoneHandle

(

)

const

thermalZoneMaterialName()

std::string openstudio::ThreeUserData::thermalZoneMaterialName

(

)

const

thermalZoneName()

std::string openstudio::ThreeUserData::thermalZoneName

(

)

const

ThermalZone name if any.

windExposure()

std::string openstudio::ThreeUserData::windExposure

(

)

const