OpenStudio:utilities
Loading...
Searching...
No Matches
openstudio::StandardsJSON Class Reference

#include <StandardsJSON.hpp>

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

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

Detailed Description

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

Constructor & Destructor Documentation

◆ StandardsJSON() [1/3]

openstudio::StandardsJSON::StandardsJSON ( )

◆ StandardsJSON() [2/3]

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

Constructor with string, will throw if string is incorrect.

◆ StandardsJSON() [3/3]

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

Protected constructor from impl.

Member Function Documentation

◆ clone()

StandardsJSON openstudio::StandardsJSON::clone ( ) const

Clones this StandardsJSON into a separate one.

◆ getPrimaryKey()

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.

◆ load()

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

Attempt to load a StandardsJSON from string.

◆ string()

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

Get the json as a string.

◆ toJSON()

Json::Value openstudio::StandardsJSON::toJSON ( ) const