OpenStudio:utilities/idd
Loading...
Searching...
No Matches
openstudio::IddKey Class Reference

#include <IddKey.hpp>

Public Member Functions

Constructors and Destructors
 IddKey ()
 Default constructor.
 
 IddKey (const IddKey &other)
 Copy constructor shares implementation.
 
Getters
std::string name () const
 Returns the key name.
 
const IddKeyPropertiesproperties () const
 Returns the key properties.
 
Queries
bool operator== (const IddKey &other) const
 Returns true if all data is exactly equal.
 
bool operator!= (const IddKey &other) const
 Negation of operator==.
 

Related Symbols

(Note that these are not member symbols.)

using IddKeyVector = std::vector<IddKey>
 
std::ostream & operator<< (std::ostream &os, const IddKey &iddKey)
 
using OptionalIddKey = boost::optional<IddKey>
 

Serialization

std::ostream & print (std::ostream &os) const
 Print to os in standard IDD format.
 
static boost::optional< IddKeyload (const std::string &name, const std::string &text)
 Load from text.
 

Detailed Description

IddKey represents an enumeration value for an IDD field of type choice.

Constructor & Destructor Documentation

◆ IddKey() [1/2]

openstudio::IddKey::IddKey ( )

Default constructor.

◆ IddKey() [2/2]

openstudio::IddKey::IddKey ( const IddKey & other)

Copy constructor shares implementation.

Member Function Documentation

◆ load()

static boost::optional< IddKey > openstudio::IddKey::load ( const std::string & name,
const std::string & text )
static

Load from text.

◆ name()

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

Returns the key name.

◆ operator!=()

bool openstudio::IddKey::operator!= ( const IddKey & other) const

Negation of operator==.

◆ operator==()

bool openstudio::IddKey::operator== ( const IddKey & other) const

Returns true if all data is exactly equal.

◆ print()

std::ostream & openstudio::IddKey::print ( std::ostream & os) const

Print to os in standard IDD format.

◆ properties()

const IddKeyProperties & openstudio::IddKey::properties ( ) const

Returns the key properties.

Friends And Related Symbol Documentation

◆ IddKeyVector

using IddKeyVector = std::vector<IddKey>
related

◆ operator<<()

std::ostream & operator<< ( std::ostream & os,
const IddKey & iddKey )
related

◆ OptionalIddKey

using OptionalIddKey = boost::optional<IddKey>
related