All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Related Functions | List of all members
openstudio::IddKey Class Reference

#include <IddKey.hpp>

Public Member Functions

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

Related Functions

(Note that these are not member functions.)

typedef std::vector< IddKeyIddKeyVector
std::ostream & operator<< (std::ostream &os, const IddKey &iddKey)
typedef boost::optional< IddKeyOptionalIddKey


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

Detailed Description

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

Constructor & Destructor Documentation

openstudio::IddKey::IddKey ( )

Default constructor.

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

Copy constructor shares implementation.

Member Function Documentation

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

Load from text.

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

Returns the key name.

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

Negation of operator==.

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

Returns true if all data is exactly equal.

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

Print to os in standard IDD format.

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

Returns the key properties.

Friends And Related Function Documentation

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