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

#include <StandardsJSON.hpp>

Public Member Functions

StandardsJSON clone () const
 Clones this StandardsJSON into a separate one. More...
 
boost::optional< Json::Value > getPrimaryKey (const std::string &primaryKey) const
 Tries to get the primaryKey, checking that the resulting object is indeed an arrray. More...
 
 StandardsJSON ()
 
 StandardsJSON (const std::string &s)
 Constructor with string, will throw if string is incorrect. More...
 
std::string string () const
 Get the json as a string. More...
 

Static Public Member Functions

static boost::optional
< StandardsJSON
load (const std::string &s)
 Attempt to load a StandardsJSON from string. More...
 

Protected Member Functions

 StandardsJSON (std::shared_ptr< detail::StandardsJSON_Impl > impl)
 Protected constructor from impl. More...
 

Detailed Description

Class for accessing the OpenStudio Standards (OSW) JSON format.

Constructor & Destructor Documentation

openstudio::StandardsJSON::StandardsJSON ( )
openstudio::StandardsJSON::StandardsJSON ( const std::string &  s)

Constructor with string, will throw if string is incorrect.

openstudio::StandardsJSON::StandardsJSON ( std::shared_ptr< detail::StandardsJSON_Impl >  impl)
protected

Protected constructor from impl.

Member Function Documentation

StandardsJSON openstudio::StandardsJSON::clone ( ) const

Clones this StandardsJSON into a separate one.

boost::optional<Json::Value> openstudio::StandardsJSON::getPrimaryKey ( const std::string &  primaryKey) const

Tries to get the primaryKey, checking that the resulting object is indeed an arrray.

static boost::optional<StandardsJSON> openstudio::StandardsJSON::load ( const std::string &  s)
static

Attempt to load a StandardsJSON from string.

std::string openstudio::StandardsJSON::string ( ) const

Get the json as a string.