#include "IddObjectProperties.hpp"

Public Member Functions
	IddObjectProperties ()
bool	operator!= (const IddObjectProperties &other) const
bool	operator== (const IddObjectProperties &other) const
std::ostream &	print (std::ostream &os) const

Public Attributes
bool	extensible
std::string	format
bool	hasURL
boost::optional< unsigned >	maxFields
std::string	memo
unsigned	minFields
unsigned	numExtensible
unsigned	numExtensibleGroupsRequired
bool	obsolete
bool	required
bool	unique

Detailed Description

IddObjectProperties describes the properties of an IddObject, as specified by object-level IDD markup.

Constructor & Destructor Documentation

openstudio::IddObjectProperties::IddObjectProperties ( )

Default constructor.

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

Negation of operator==.

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

Returns true if all of the underlying data is exactly equal.

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

Print object-level IDD flags to os.

Includes indentation for IDD file readability.

bool openstudio::IddObjectProperties::extensible

Returns true if this object is extensible.

std::string openstudio::IddObjectProperties::format

Formatting markup for this object.

Often empty. Contains suggestions for printing certain types of IdfObjects. For instance, many geometric objects have \format vertices.

bool openstudio::IddObjectProperties::hasURL

Returns true if this object contains an IddField of type url.

boost::optional<unsigned> openstudio::IddObjectProperties::maxFields

Maximum number of fields allowed in IdfObjects following this schema.

Limits the number of allowable extensible groups.

std::string openstudio::IddObjectProperties::memo

Returns the memo associated with this object.

unsigned openstudio::IddObjectProperties::minFields

Minimum number of fields required for an IdfObject to be valid according to this schema.

unsigned openstudio::IddObjectProperties::numExtensible

Returns the number of fields in this object's extensible group (zero if !extensible).

unsigned openstudio::IddObjectProperties::numExtensibleGroupsRequired

Returns the minimum number of extensible groups an IdfObject following this schema must have to be valid.

bool openstudio::IddObjectProperties::obsolete

Returns true if this object is obsolete.

bool openstudio::IddObjectProperties::required

Returns true if this object is required for an IdfFile to be valid.

bool openstudio::IddObjectProperties::unique

Returns true if this object must be unique within an individual IdfFile.