OpenStudio:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
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. More...
 
std::string buildingUnitHandle () const
 
std::string buildingUnitMaterialName () const
 
std::string buildingUnitName () const
 BuildingUnit name if any. More...
 
bool coincidentWithOutsideObject () const
 
std::string constructionHandle () const
 
std::string constructionMaterialName () const
 
std::string constructionName () const
 Construction name if any. More...
 
std::string constructionSetHandle () const
 
std::string constructionSetMaterialName () const
 
std::string constructionSetName () const
 ConstructionSet name if any. More...
 
std::string handle () const
 
double illuminanceSetpoint () 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 setHandle (const std::string &s)
 
void setIlluminanceSetpoint (double d)
 
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 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. More...
 
std::string spaceHandle () const
 
std::string spaceName () const
 Parent spaces name if any. More...
 
std::string spaceTypeHandle () const
 
std::string spaceTypeMaterialName () const
 
std::string spaceTypeName () const
 SpaceType name if any. More...
 
std::string subSurfaceHandle () const
 
std::string subSurfaceName () const
 Parent sub surface name if any. More...
 
std::string sunExposure () const
 
std::string surfaceHandle () const
 
std::string surfaceName () const
 Parent surface name if any. More...
 
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"} More...
 
std::string surfaceTypeMaterialName () const
 
std::string thermalZoneHandle () const
 
std::string thermalZoneMaterialName () const
 
std::string thermalZoneName () const
 ThermalZone name if any. More...
 
 ThreeUserData ()
 
std::string windExposure () const
 

Detailed Description

ThreeUserData decorates a ThreeSceneChild with additional information.

Constructor & Destructor Documentation

openstudio::ThreeUserData::ThreeUserData ( )

Member Function Documentation

void openstudio::ThreeUserData::addAirLoopHVACHandle ( const std::string &  s)
void openstudio::ThreeUserData::addAirLoopHVACMaterialName ( const std::string &  s)
void openstudio::ThreeUserData::addAirLoopHVACName ( const std::string &  s)
std::vector<std::string> openstudio::ThreeUserData::airLoopHVACHandles ( ) const
std::vector<std::string> openstudio::ThreeUserData::airLoopHVACMaterialNames ( ) const
std::vector<std::string> openstudio::ThreeUserData::airLoopHVACNames ( ) const
bool openstudio::ThreeUserData::airWall ( ) const
std::string openstudio::ThreeUserData::boundaryMaterialName ( ) const
std::string openstudio::ThreeUserData::buildingStoryHandle ( ) const
std::string openstudio::ThreeUserData::buildingStoryMaterialName ( ) const
std::string openstudio::ThreeUserData::buildingStoryName ( ) const

BuildingStory name if any.

std::string openstudio::ThreeUserData::buildingUnitHandle ( ) const
std::string openstudio::ThreeUserData::buildingUnitMaterialName ( ) const
std::string openstudio::ThreeUserData::buildingUnitName ( ) const

BuildingUnit name if any.

bool openstudio::ThreeUserData::coincidentWithOutsideObject ( ) const
std::string openstudio::ThreeUserData::constructionHandle ( ) const
std::string openstudio::ThreeUserData::constructionMaterialName ( ) const
std::string openstudio::ThreeUserData::constructionName ( ) const

Construction name if any.

std::string openstudio::ThreeUserData::constructionSetHandle ( ) const
std::string openstudio::ThreeUserData::constructionSetMaterialName ( ) const
std::string openstudio::ThreeUserData::constructionSetName ( ) const

ConstructionSet name if any.

std::string openstudio::ThreeUserData::handle ( ) const
double openstudio::ThreeUserData::illuminanceSetpoint ( ) const
std::string openstudio::ThreeUserData::name ( ) const
std::string openstudio::ThreeUserData::outsideBoundaryCondition ( ) const
std::string openstudio::ThreeUserData::outsideBoundaryConditionObjectHandle ( ) const
std::string openstudio::ThreeUserData::outsideBoundaryConditionObjectName ( ) const
void openstudio::ThreeUserData::setAirWall ( bool  b)
void openstudio::ThreeUserData::setBoundaryMaterialName ( const std::string &  s)
void openstudio::ThreeUserData::setBuildingStoryHandle ( const std::string &  s)
void openstudio::ThreeUserData::setBuildingStoryMaterialName ( const std::string &  s)
void openstudio::ThreeUserData::setBuildingStoryName ( const std::string &  s)
void openstudio::ThreeUserData::setBuildingUnitHandle ( const std::string &  s)
void openstudio::ThreeUserData::setBuildingUnitMaterialName ( const std::string &  s)
void openstudio::ThreeUserData::setBuildingUnitName ( const std::string &  s)
void openstudio::ThreeUserData::setCoincidentWithOutsideObject ( bool  b)
void openstudio::ThreeUserData::setConstructionHandle ( const std::string &  s)
void openstudio::ThreeUserData::setConstructionMaterialName ( const std::string &  s)
void openstudio::ThreeUserData::setConstructionName ( const std::string &  s)
void openstudio::ThreeUserData::setConstructionSetHandle ( const std::string &  s)
void openstudio::ThreeUserData::setConstructionSetMaterialName ( const std::string &  s)
void openstudio::ThreeUserData::setConstructionSetName ( const std::string &  s)
void openstudio::ThreeUserData::setHandle ( const std::string &  s)
void openstudio::ThreeUserData::setIlluminanceSetpoint ( double  d)
void openstudio::ThreeUserData::setName ( const std::string &  s)
void openstudio::ThreeUserData::setOutsideBoundaryCondition ( const std::string &  s)
void openstudio::ThreeUserData::setOutsideBoundaryConditionObjectHandle ( const std::string &  s)
void openstudio::ThreeUserData::setOutsideBoundaryConditionObjectName ( const std::string &  s)
void openstudio::ThreeUserData::setShadingHandle ( const std::string &  s)
void openstudio::ThreeUserData::setShadingName ( const std::string &  s)
void openstudio::ThreeUserData::setSpaceHandle ( const std::string &  s)
void openstudio::ThreeUserData::setSpaceName ( const std::string &  s)
void openstudio::ThreeUserData::setSpaceTypeHandle ( const std::string &  s)
void openstudio::ThreeUserData::setSpaceTypeMaterialName ( const std::string &  s)
void openstudio::ThreeUserData::setSpaceTypeName ( const std::string &  s)
void openstudio::ThreeUserData::setSubSurfaceHandle ( const std::string &  s)
void openstudio::ThreeUserData::setSubSurfaceName ( const std::string &  s)
void openstudio::ThreeUserData::setSunExposure ( const std::string &  s)
void openstudio::ThreeUserData::setSurfaceHandle ( const std::string &  s)
void openstudio::ThreeUserData::setSurfaceName ( const std::string &  s)
void openstudio::ThreeUserData::setSurfaceType ( const std::string &  s)
void openstudio::ThreeUserData::setSurfaceTypeMaterialName ( const std::string &  s)
void openstudio::ThreeUserData::setThermalZoneHandle ( const std::string &  s)
void openstudio::ThreeUserData::setThermalZoneMaterialName ( const std::string &  s)
void openstudio::ThreeUserData::setThermalZoneName ( const std::string &  s)
void openstudio::ThreeUserData::setWindExposure ( const std::string &  s)
std::string openstudio::ThreeUserData::shadingHandle ( ) const
std::string openstudio::ThreeUserData::shadingName ( ) const

Parent shading name if any.

std::string openstudio::ThreeUserData::spaceHandle ( ) const
std::string openstudio::ThreeUserData::spaceName ( ) const

Parent spaces name if any.

std::string openstudio::ThreeUserData::spaceTypeHandle ( ) const
std::string openstudio::ThreeUserData::spaceTypeMaterialName ( ) const
std::string openstudio::ThreeUserData::spaceTypeName ( ) const

SpaceType name if any.

std::string openstudio::ThreeUserData::subSurfaceHandle ( ) const
std::string openstudio::ThreeUserData::subSurfaceName ( ) const

Parent sub surface name if any.

std::string openstudio::ThreeUserData::sunExposure ( ) const
std::string openstudio::ThreeUserData::surfaceHandle ( ) const
std::string openstudio::ThreeUserData::surfaceName ( ) const

Parent surface name if any.

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"}

std::string openstudio::ThreeUserData::surfaceTypeMaterialName ( ) const
std::string openstudio::ThreeUserData::thermalZoneHandle ( ) const
std::string openstudio::ThreeUserData::thermalZoneMaterialName ( ) const
std::string openstudio::ThreeUserData::thermalZoneName ( ) const

ThermalZone name if any.

std::string openstudio::ThreeUserData::windExposure ( ) const