OpenStudio:utilities/idd
Loading...
Searching...
No Matches
openstudio::IddObjectProperties Struct Reference

#include <IddObjectProperties.hpp>

Public Member Functions

 IddObjectProperties ()
 Default constructor.
 
bool operator!= (const IddObjectProperties &other) const
 Negation of operator==.
 
bool operator== (const IddObjectProperties &other) const
 Returns true if all of the underlying data is exactly equal.
 
std::ostream & print (std::ostream &os) const
 Print object-level IDD flags to os.
 

Public Attributes

bool extensible
 Returns true if this object is extensible.
 
std::string format
 Formatting markup for this object.
 
bool hasURL
 Returns true if this object contains an IddField of type url.
 
boost::optional< unsigned > maxFields
 Maximum number of fields allowed in IdfObjects following this schema.
 
std::string memo
 Returns the memo associated with this object.
 
unsigned minFields
 Minimum number of fields required for an IdfObject to be valid according to this schema.
 
unsigned numExtensible
 Returns the number of fields in this object's extensible group (zero if !extensible).
 
unsigned numExtensibleGroupsRequired
 Returns the minimum number of extensible groups an IdfObject following this schema must have to be valid.
 
bool obsolete
 Returns true if this object is obsolete.
 
bool required
 Returns true if this object is required for an IdfFile to be valid.
 
bool unique
 Returns true if this object must be unique within an individual IdfFile.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ IddObjectProperties()

openstudio::IddObjectProperties::IddObjectProperties ( )

Default constructor.

Member Function Documentation

◆ operator!=()

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

Negation of operator==.

◆ operator==()

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

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

◆ print()

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

Print object-level IDD flags to os.

Includes indentation for IDD file readability.

Member Data Documentation

◆ extensible

bool openstudio::IddObjectProperties::extensible

Returns true if this object is extensible.

◆ format

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.

◆ hasURL

bool openstudio::IddObjectProperties::hasURL

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

◆ maxFields

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

Maximum number of fields allowed in IdfObjects following this schema.

Limits the number of allowable extensible groups.

◆ memo

std::string openstudio::IddObjectProperties::memo

Returns the memo associated with this object.

◆ minFields

unsigned openstudio::IddObjectProperties::minFields

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

◆ numExtensible

unsigned openstudio::IddObjectProperties::numExtensible

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

◆ numExtensibleGroupsRequired

unsigned openstudio::IddObjectProperties::numExtensibleGroupsRequired

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

◆ obsolete

bool openstudio::IddObjectProperties::obsolete

Returns true if this object is obsolete.

◆ required

bool openstudio::IddObjectProperties::required

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

◆ unique

bool openstudio::IddObjectProperties::unique

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