 |
OpenStudio:utilities/idd |
|
OpenStudio:utilities/idd |
#include <IddFieldProperties.hpp>
Public Types | |
| enum | BoundTypes { Unbounded, InclusiveBound, ExclusiveBound } |
| Enumeration indicating the type of numeric bound to be applied. More... | |
Public Member Functions | |
| IddFieldProperties () | |
| Default constructor. More... | |
| bool | isGeneric () const |
| Returns true if no properties other than type are set. More... | |
| bool | operator!= (const IddFieldProperties &other) const |
| Negation of operator==. More... | |
| bool | operator== (const IddFieldProperties &other) const |
| Returns true if all underlying data is exactly equal. More... | |
| std::ostream & | print (std::ostream &os) const |
| Prints these field properties to os, in standard IDD format. More... | |
Public Attributes | |
| bool | autocalculatable |
| True if the field autocalculatable. More... | |
| bool | autosizable |
| True if the field data is autosizable. More... | |
| bool | beginExtensible |
| True if this field is the first in an extensible group. More... | |
| bool | deprecated |
| True if this field has been deprecated (should not be used, but is okay for legacy files). More... | |
| std::vector< std::string > | externalLists |
| This field points to a name registered in another file (typically the RDD file). More... | |
| boost::optional< std::string > | ipUnits |
| The EnergyPlus-format unit string indicating this field's IP units. More... | |
| boost::optional< std::string > | maxBoundText |
| BoundTypes | maxBoundType |
| Maximum bound is non-existent (Unbounded), <= (InclusiveBound), or < (ExclusiveBound). More... | |
| boost::optional< double > | maxBoundValue |
| boost::optional< std::string > | minBoundText |
| BoundTypes | minBoundType |
| Minimum bound is non-existent (Unbounded), >= (InclusiveBound), or > (ExclusiveBound). More... | |
| boost::optional< double > | minBoundValue |
| std::string | note |
| Field notes collected into one string. More... | |
| boost::optional< double > | numericDefault |
| The default value as double. More... | |
| std::vector< std::string > | objectLists |
| This field points to an IdfObject that is registered with one of the reference lists named in this vector. More... | |
| std::vector< std::string > | referenceClassNames |
| This field specifies that the containing IdfObject belongs to the following reference-class-name lists. More... | |
| std::vector< std::string > | references |
| This field specifies that the containing IdfObject belongs to the following reference lists. More... | |
| bool | required |
| True if this field is required (must be filled in for the IdfObject to be valid). More... | |
| bool | retaincase |
| True if the field value is case-sensitive. More... | |
| boost::optional< std::string > | stringDefault |
| The default value as string. More... | |
| IddFieldType | type |
| Field type (alpha, numeric, various flavors of alpha providing links to other objects and files). More... | |
| boost::optional< std::string > | units |
| The EnergyPlus-format unit string for this field. More... | |
IddFieldProperties describes the properties of an IddField object, as specified by IDD markup.
| openstudio::IddFieldProperties::IddFieldProperties | ( | ) |
Default constructor.
| bool openstudio::IddFieldProperties::isGeneric | ( | ) | const |
Returns true if no properties other than type are set.
| bool openstudio::IddFieldProperties::operator!= | ( | const IddFieldProperties & | other | ) | const |
Negation of operator==.
| bool openstudio::IddFieldProperties::operator== | ( | const IddFieldProperties & | other | ) | const |
Returns true if all underlying data is exactly equal.
| std::ostream& openstudio::IddFieldProperties::print | ( | std::ostream & | os | ) | const |
Prints these field properties to os, in standard IDD format.
| bool openstudio::IddFieldProperties::autocalculatable |
True if the field autocalculatable.
| bool openstudio::IddFieldProperties::autosizable |
True if the field data is autosizable.
| bool openstudio::IddFieldProperties::beginExtensible |
True if this field is the first in an extensible group.
| bool openstudio::IddFieldProperties::deprecated |
True if this field has been deprecated (should not be used, but is okay for legacy files).
| std::vector<std::string> openstudio::IddFieldProperties::externalLists |
This field points to a name registered in another file (typically the RDD file).
OpenStudio treats these fields as plain (unparsed) text.
| boost::optional<std::string> openstudio::IddFieldProperties::ipUnits |
The EnergyPlus-format unit string indicating this field's IP units.
No effect on underlying data; a suggestion for user-facing displays.
| boost::optional<std::string> openstudio::IddFieldProperties::maxBoundText |
| BoundTypes openstudio::IddFieldProperties::maxBoundType |
Maximum bound is non-existent (Unbounded), <= (InclusiveBound), or < (ExclusiveBound).
| boost::optional<double> openstudio::IddFieldProperties::maxBoundValue |
| boost::optional<std::string> openstudio::IddFieldProperties::minBoundText |
| BoundTypes openstudio::IddFieldProperties::minBoundType |
Minimum bound is non-existent (Unbounded), >= (InclusiveBound), or > (ExclusiveBound).
| boost::optional<double> openstudio::IddFieldProperties::minBoundValue |
| std::string openstudio::IddFieldProperties::note |
Field notes collected into one string.
| boost::optional<double> openstudio::IddFieldProperties::numericDefault |
The default value as double.
| std::vector<std::string> openstudio::IddFieldProperties::objectLists |
This field points to an IdfObject that is registered with one of the reference lists named in this vector.
The list names are defined by \reference markup of name fields. There is also an OpenStudio-specific universal reference list called 'AllObjects'.
| std::vector<std::string> openstudio::IddFieldProperties::referenceClassNames |
This field specifies that the containing IdfObject belongs to the following reference-class-name lists.
| std::vector<std::string> openstudio::IddFieldProperties::references |
This field specifies that the containing IdfObject belongs to the following reference lists.
This information can be used by other objects to point to (reference) this object using \object-list markup.
| bool openstudio::IddFieldProperties::required |
True if this field is required (must be filled in for the IdfObject to be valid).
| bool openstudio::IddFieldProperties::retaincase |
True if the field value is case-sensitive.
| boost::optional<std::string> openstudio::IddFieldProperties::stringDefault |
The default value as string.
| IddFieldType openstudio::IddFieldProperties::type |
Field type (alpha, numeric, various flavors of alpha providing links to other objects and files).
| boost::optional<std::string> openstudio::IddFieldProperties::units |
The EnergyPlus-format unit string for this field.
All data are assumed to be associated with these (typically SI) units.