openstudio::gltf::GltfUserData Class Reference

#include <GltfUserData.hpp>

Public Member Functions
	GltfUserData ()
Interface with Model and ModelObjects
	GltfUserData (const model::PlanarSurface &planarSurface)
Getters & Setters
std::string	handle () const
void	setHandle (const std::string &handle)
std::string	name () const
void	setName (const std::string &name)
std::string	surfaceType () const
void	setSurfaceType (const std::string &surfaceType)
std::string	constructionName () const
void	setConstructionName (const std::string &constructionName)
std::string	constructionHandle () const
void	setConstructionHandle (const std::string &constructionHandle)
std::string	constructionMaterialName () const
void	setConstructionMaterialName (const std::string &constructionMaterialName)
std::string	surfaceName () const
void	setSurfaceName (const std::string &surfaceName)
std::string	surfaceHandle () const
void	setSurfaceHandle (const std::string &surfaceHandle)
std::string	subSurfaceName () const
void	setSubSurfaceName (const std::string &subSurfaceName)
std::string	subSurfaceHandle () const
void	setSubSurfaceHandle (const std::string &subSurfaceHandle)
std::string	spaceName () const
void	setSpaceName (const std::string &spaceName)
std::string	spaceHandle () const
void	setSpaceHandle (const std::string &spaceHandle)
std::string	shadingName () const
void	setShadingName (const std::string &shadingName)
std::string	shadingHandle () const
void	setShadingHandle (const std::string &shadingHandle)
std::string	thermalZoneName () const
void	setThermalZoneName (const std::string &thermalZoneName)
std::string	thermalZoneHandle () const
void	setThermalZoneHandle (const std::string &thermalZoneHandle)
std::string	thermalZoneMaterialName () const
void	setThermalZoneMaterialName (const std::string &thermalZoneMaterialName)
std::string	spaceTypeName () const
void	setSpaceTypeName (const std::string &spaceTypeName)
std::string	spaceTypeHandle () const
void	setSpaceTypeHandle (const std::string &spaceTypeHandle)
std::string	spaceTypeMaterialName () const
void	setSpaceTypeMaterialName (const std::string &spaceTypeMaterialName)
std::string	buildingStoryName () const
void	setBuildingStoryName (const std::string &buildingStoryName)
std::string	buildingStoryHandle () const
void	setBuildingStoryHandle (const std::string &buildingStoryHandle)
std::string	buildingStoryMaterialName () const
void	setBuildingStoryMaterialName (const std::string &buildingStoryMaterialName)
std::string	buildingUnitName () const
void	setBuildingUnitName (const std::string &buildingUnitName)
std::string	buildingUnitHandle () const
void	setBuildingUnitHandle (const std::string &buildingUnitHandle)
std::string	buildingUnitMaterialName () const
void	setBuildingUnitMaterialName (const std::string &buildingUnitMaterialName)
std::string	constructionSetName () const
void	setConstructionSetName (const std::string &constructionSetName)
std::string	constructionSetHandle () const
void	setConstructionSetHandle (const std::string &constructionSetHandle)
std::string	constructionSetMaterialName () const
void	setConstructionSetMaterialName (const std::string &constructionSetMaterialName)
std::string	outsideBoundaryCondition () const
void	setOutsideBoundaryCondition (const std::string &outsideBoundaryCondition)
std::string	outsideBoundaryConditionObjectName () const
void	setOutsideBoundaryConditionObjectName (const std::string &outsideBoundaryConditionObjectName)
std::string	outsideBoundaryConditionObjectHandle () const
void	setOutsideBoundaryConditionObjectHandle (const std::string &outsideBoundaryConditionObjectHandle)
bool	coincidentWithOutsideObject () const
void	setCoincidentWithOutsideObject (bool coincidentWithOutsideObject)
std::string	sunExposure () const
void	setSunExposure (const std::string &sunExposure)
std::string	windExposure () const
void	setWindExposure (const std::string &windExposure)
double	illuminanceSetpoint () const
void	setIlluminanceSetpoint (double illuminanceSetpoint)
bool	airWall () const
void	setAirWall (bool airWall)
std::vector< std::string >	airLoopHVACNames () const
void	setAirLoopHVACNames (const std::vector< std::string > &airLoopHVACNames)
void	addAirLoopHVACName (std::string airLoopHVACName)
std::vector< std::string >	airLoopHVACHandles () const
void	setAirLoopHVACHandles (const std::vector< std::string > &airLoopHVACHandles)
void	addAirLoopHVACHandle (std::string airLoopHVACHandle)
std::vector< std::string >	airLoopHVACMaterialNames () const
void	setAirLoopHVACMaterialNames (const std::vector< std::string > &airLoopHVACMaterialNames)
void	addAirLoopHVACMaterialName (std::string airLoopHVACMaterialName)
Other
std::string	surfaceTypeMaterialName () const
std::string	boundaryMaterialName () const

Protected
	GltfUserData (const tinygltf::Value &userDataObj)
	Interface with an existing GLTF file.
std::map< std::string, tinygltf::Value >	toExtras () const

Detailed Description

GltfUserData is an Interface class between a PlanarSurface and an glTF Node's extras.

It stores attributes such as surfaceType, its construction, the Space and SpaceType and ThermalZone it belongs to, etc.

Constructor & Destructor Documentation

GltfUserData() [1/3]

openstudio::gltf::GltfUserData::GltfUserData

(

)

GltfUserData() [2/3]

openstudio::gltf::GltfUserData::GltfUserData

(

const model::PlanarSurface &

planarSurface

)

GltfUserData() [3/3]

openstudio::gltf::GltfUserData::GltfUserData ( const tinygltf::Value & userDataObj )

protected

Interface with an existing GLTF file.

Member Function Documentation

addAirLoopHVACHandle()

void openstudio::gltf::GltfUserData::addAirLoopHVACHandle

(

std::string

airLoopHVACHandle

)

addAirLoopHVACMaterialName()

void openstudio::gltf::GltfUserData::addAirLoopHVACMaterialName

(

std::string

airLoopHVACMaterialName

)

addAirLoopHVACName()

void openstudio::gltf::GltfUserData::addAirLoopHVACName

(

std::string

airLoopHVACName

)

airLoopHVACHandles()

std::vector< std::string > openstudio::gltf::GltfUserData::airLoopHVACHandles

(

)

const

airLoopHVACMaterialNames()

std::vector< std::string > openstudio::gltf::GltfUserData::airLoopHVACMaterialNames

(

)

const

airLoopHVACNames()

std::vector< std::string > openstudio::gltf::GltfUserData::airLoopHVACNames

(

)

const

airWall()

bool openstudio::gltf::GltfUserData::airWall

(

)

const

boundaryMaterialName()

std::string openstudio::gltf::GltfUserData::boundaryMaterialName

(

)

const

buildingStoryHandle()

std::string openstudio::gltf::GltfUserData::buildingStoryHandle

(

)

const

buildingStoryMaterialName()

std::string openstudio::gltf::GltfUserData::buildingStoryMaterialName

(

)

const

buildingStoryName()

std::string openstudio::gltf::GltfUserData::buildingStoryName

(

)

const

buildingUnitHandle()

std::string openstudio::gltf::GltfUserData::buildingUnitHandle

(

)

const

buildingUnitMaterialName()

std::string openstudio::gltf::GltfUserData::buildingUnitMaterialName

(

)

const

buildingUnitName()

std::string openstudio::gltf::GltfUserData::buildingUnitName

(

)

const

coincidentWithOutsideObject()

bool openstudio::gltf::GltfUserData::coincidentWithOutsideObject

(

)

const

constructionHandle()

std::string openstudio::gltf::GltfUserData::constructionHandle

(

)

const

constructionMaterialName()

std::string openstudio::gltf::GltfUserData::constructionMaterialName

(

)

const

constructionName()

std::string openstudio::gltf::GltfUserData::constructionName

(

)

const

constructionSetHandle()

std::string openstudio::gltf::GltfUserData::constructionSetHandle

(

)

const

constructionSetMaterialName()

std::string openstudio::gltf::GltfUserData::constructionSetMaterialName

(

)

const

constructionSetName()

std::string openstudio::gltf::GltfUserData::constructionSetName

(

)

const

handle()

std::string openstudio::gltf::GltfUserData::handle

(

)

const

illuminanceSetpoint()

double openstudio::gltf::GltfUserData::illuminanceSetpoint

(

)

const

name()

std::string openstudio::gltf::GltfUserData::name

(

)

const

outsideBoundaryCondition()

std::string openstudio::gltf::GltfUserData::outsideBoundaryCondition

(

)

const

outsideBoundaryConditionObjectHandle()

std::string openstudio::gltf::GltfUserData::outsideBoundaryConditionObjectHandle

(

)

const

outsideBoundaryConditionObjectName()

std::string openstudio::gltf::GltfUserData::outsideBoundaryConditionObjectName

(

)

const

setAirLoopHVACHandles()

void openstudio::gltf::GltfUserData::setAirLoopHVACHandles

(

const std::vector< std::string > &

airLoopHVACHandles

)

setAirLoopHVACMaterialNames()

void openstudio::gltf::GltfUserData::setAirLoopHVACMaterialNames

(

const std::vector< std::string > &

airLoopHVACMaterialNames

)

setAirLoopHVACNames()

void openstudio::gltf::GltfUserData::setAirLoopHVACNames

(

const std::vector< std::string > &

airLoopHVACNames

)

setAirWall()

void openstudio::gltf::GltfUserData::setAirWall

(

bool

airWall

)

setBuildingStoryHandle()

void openstudio::gltf::GltfUserData::setBuildingStoryHandle

(

const std::string &

buildingStoryHandle

)

setBuildingStoryMaterialName()

void openstudio::gltf::GltfUserData::setBuildingStoryMaterialName

(

const std::string &

buildingStoryMaterialName

)

setBuildingStoryName()

void openstudio::gltf::GltfUserData::setBuildingStoryName

(

const std::string &

buildingStoryName

)

setBuildingUnitHandle()

void openstudio::gltf::GltfUserData::setBuildingUnitHandle

(

const std::string &

buildingUnitHandle

)

setBuildingUnitMaterialName()

void openstudio::gltf::GltfUserData::setBuildingUnitMaterialName

(

const std::string &

buildingUnitMaterialName

)

setBuildingUnitName()

void openstudio::gltf::GltfUserData::setBuildingUnitName

(

const std::string &

buildingUnitName

)

setCoincidentWithOutsideObject()

void openstudio::gltf::GltfUserData::setCoincidentWithOutsideObject

(

bool

coincidentWithOutsideObject

)

setConstructionHandle()

void openstudio::gltf::GltfUserData::setConstructionHandle

(

const std::string &

constructionHandle

)

setConstructionMaterialName()

void openstudio::gltf::GltfUserData::setConstructionMaterialName

(

const std::string &

constructionMaterialName

)

setConstructionName()

void openstudio::gltf::GltfUserData::setConstructionName

(

const std::string &

constructionName

)

setConstructionSetHandle()

void openstudio::gltf::GltfUserData::setConstructionSetHandle

(

const std::string &

constructionSetHandle

)

setConstructionSetMaterialName()

void openstudio::gltf::GltfUserData::setConstructionSetMaterialName

(

const std::string &

constructionSetMaterialName

)

setConstructionSetName()

void openstudio::gltf::GltfUserData::setConstructionSetName

(

const std::string &

constructionSetName

)

setHandle()

void openstudio::gltf::GltfUserData::setHandle

(

const std::string &

handle

)

setIlluminanceSetpoint()

void openstudio::gltf::GltfUserData::setIlluminanceSetpoint

(

double

illuminanceSetpoint

)

setName()

void openstudio::gltf::GltfUserData::setName

(

const std::string &

name

)

setOutsideBoundaryCondition()

void openstudio::gltf::GltfUserData::setOutsideBoundaryCondition

(

const std::string &

outsideBoundaryCondition

)

setOutsideBoundaryConditionObjectHandle()

void openstudio::gltf::GltfUserData::setOutsideBoundaryConditionObjectHandle

(

const std::string &

outsideBoundaryConditionObjectHandle

)

setOutsideBoundaryConditionObjectName()

void openstudio::gltf::GltfUserData::setOutsideBoundaryConditionObjectName

(

const std::string &

outsideBoundaryConditionObjectName

)

setShadingHandle()

void openstudio::gltf::GltfUserData::setShadingHandle

(

const std::string &

shadingHandle

)

setShadingName()

void openstudio::gltf::GltfUserData::setShadingName

(

const std::string &

shadingName

)

setSpaceHandle()

void openstudio::gltf::GltfUserData::setSpaceHandle

(

const std::string &

spaceHandle

)

setSpaceName()

void openstudio::gltf::GltfUserData::setSpaceName

(

const std::string &

spaceName

)

setSpaceTypeHandle()

void openstudio::gltf::GltfUserData::setSpaceTypeHandle

(

const std::string &

spaceTypeHandle

)

setSpaceTypeMaterialName()

void openstudio::gltf::GltfUserData::setSpaceTypeMaterialName

(

const std::string &

spaceTypeMaterialName

)

setSpaceTypeName()

void openstudio::gltf::GltfUserData::setSpaceTypeName

(

const std::string &

spaceTypeName

)

setSubSurfaceHandle()

void openstudio::gltf::GltfUserData::setSubSurfaceHandle

(

const std::string &

subSurfaceHandle

)

setSubSurfaceName()

void openstudio::gltf::GltfUserData::setSubSurfaceName

(

const std::string &

subSurfaceName

)

setSunExposure()

void openstudio::gltf::GltfUserData::setSunExposure

(

const std::string &

sunExposure

)

setSurfaceHandle()

void openstudio::gltf::GltfUserData::setSurfaceHandle

(

const std::string &

surfaceHandle

)

setSurfaceName()

void openstudio::gltf::GltfUserData::setSurfaceName

(

const std::string &

surfaceName

)

setSurfaceType()

void openstudio::gltf::GltfUserData::setSurfaceType

(

const std::string &

surfaceType

)

setThermalZoneHandle()

void openstudio::gltf::GltfUserData::setThermalZoneHandle

(

const std::string &

thermalZoneHandle

)

setThermalZoneMaterialName()

void openstudio::gltf::GltfUserData::setThermalZoneMaterialName

(

const std::string &

thermalZoneMaterialName

)

setThermalZoneName()

void openstudio::gltf::GltfUserData::setThermalZoneName

(

const std::string &

thermalZoneName

)

setWindExposure()

void openstudio::gltf::GltfUserData::setWindExposure

(

const std::string &

windExposure

)

shadingHandle()

std::string openstudio::gltf::GltfUserData::shadingHandle

(

)

const

shadingName()

std::string openstudio::gltf::GltfUserData::shadingName

(

)

const

spaceHandle()

std::string openstudio::gltf::GltfUserData::spaceHandle

(

)

const

spaceName()

std::string openstudio::gltf::GltfUserData::spaceName

(

)

const

spaceTypeHandle()

std::string openstudio::gltf::GltfUserData::spaceTypeHandle

(

)

const

spaceTypeMaterialName()

std::string openstudio::gltf::GltfUserData::spaceTypeMaterialName

(

)

const

spaceTypeName()

std::string openstudio::gltf::GltfUserData::spaceTypeName

(

)

const

subSurfaceHandle()

std::string openstudio::gltf::GltfUserData::subSurfaceHandle

(

)

const

subSurfaceName()

std::string openstudio::gltf::GltfUserData::subSurfaceName

(

)

const

sunExposure()

std::string openstudio::gltf::GltfUserData::sunExposure

(

)

const

surfaceHandle()

std::string openstudio::gltf::GltfUserData::surfaceHandle

(

)

const

surfaceName()

std::string openstudio::gltf::GltfUserData::surfaceName

(

)

const

surfaceType()

std::string openstudio::gltf::GltfUserData::surfaceType

(

)

const

surfaceTypeMaterialName()

std::string openstudio::gltf::GltfUserData::surfaceTypeMaterialName

(

)

const

thermalZoneHandle()

std::string openstudio::gltf::GltfUserData::thermalZoneHandle

(

)

const

thermalZoneMaterialName()

std::string openstudio::gltf::GltfUserData::thermalZoneMaterialName

(

)

const

thermalZoneName()

std::string openstudio::gltf::GltfUserData::thermalZoneName

(

)

const

toExtras()

std::map< std::string, tinygltf::Value > openstudio::gltf::GltfUserData::toExtras ( ) const

protected

windExposure()

std::string openstudio::gltf::GltfUserData::windExposure

(

)

const