OpenStudio:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
openstudio::FloorplanObject Class Reference

#include <FloorplanJS.hpp>

Public Member Functions

 FloorplanObject (const std::string &id, const std::string &name, const std::string &handleString)
 pass empty string for any null values More...
 
 FloorplanObject (const std::string &id, const std::string &name, const UUID &handle)
 
boost::optional< bool > getDataBool (const std::string &key) const
 
boost::optional< double > getDataDouble (const std::string &key) const
 
boost::optional< intgetDataInt (const std::string &key) const
 
boost::optional< FloorplanObjectgetDataReference (const std::string &key) const
 
boost::optional< std::string > getDataString (const std::string &key) const
 
UUID handle () const
 handle of corresponding OpenStudio Model object, will be null if none More...
 
std::string handleString () const
 handle of corresponding OpenStudio Model object, will be empty string if none More...
 
std::string id () const
 id in FloorplanJS More...
 
std::string name () const
 object name More...
 
boost::optional< std::string > parentHandleString () const
 handle of corresponding OpenStudio Model parent object, will be null if none More...
 
void resetParentHandleString ()
 
void setDataBool (const std::string &key, bool value)
 
void setDataDouble (const std::string &key, double value)
 
void setDataInt (const std::string &key, int value)
 
void setDataReference (const std::string &key, const FloorplanObject &value)
 
void setDataString (const std::string &key, const std::string &value)
 
void setParentHandleString (const std::string &parentHandleString)
 

Detailed Description

FloorplanObject is used to update data in a FloorplanJS object.

The class is not impl-ized in hopes that it can be ported to JavaScript via emscripten

Constructor & Destructor Documentation

openstudio::FloorplanObject::FloorplanObject ( const std::string &  id,
const std::string &  name,
const std::string &  handleString 
)

pass empty string for any null values

openstudio::FloorplanObject::FloorplanObject ( const std::string &  id,
const std::string &  name,
const UUID handle 
)

Member Function Documentation

boost::optional<bool> openstudio::FloorplanObject::getDataBool ( const std::string &  key) const
boost::optional<double> openstudio::FloorplanObject::getDataDouble ( const std::string &  key) const
boost::optional<int> openstudio::FloorplanObject::getDataInt ( const std::string &  key) const
boost::optional<FloorplanObject> openstudio::FloorplanObject::getDataReference ( const std::string &  key) const
boost::optional<std::string> openstudio::FloorplanObject::getDataString ( const std::string &  key) const
UUID openstudio::FloorplanObject::handle ( ) const

handle of corresponding OpenStudio Model object, will be null if none

std::string openstudio::FloorplanObject::handleString ( ) const

handle of corresponding OpenStudio Model object, will be empty string if none

std::string openstudio::FloorplanObject::id ( ) const

id in FloorplanJS

std::string openstudio::FloorplanObject::name ( ) const

object name

boost::optional<std::string> openstudio::FloorplanObject::parentHandleString ( ) const

handle of corresponding OpenStudio Model parent object, will be null if none

void openstudio::FloorplanObject::resetParentHandleString ( )
void openstudio::FloorplanObject::setDataBool ( const std::string &  key,
bool  value 
)
void openstudio::FloorplanObject::setDataDouble ( const std::string &  key,
double  value 
)
void openstudio::FloorplanObject::setDataInt ( const std::string &  key,
int  value 
)
void openstudio::FloorplanObject::setDataReference ( const std::string &  key,
const FloorplanObject value 
)
void openstudio::FloorplanObject::setDataString ( const std::string &  key,
const std::string &  value 
)
void openstudio::FloorplanObject::setParentHandleString ( const std::string &  parentHandleString)