Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 2.68 KB

Model.md

File metadata and controls

23 lines (18 loc) · 2.68 KB

DragonflySchema.Model.Model

Properties

Name Type Description Notes
Identifier string Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.
DisplayName string Display name of the object with no character restrictions. [optional]
UserData Object Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list). [optional]
Properties ModelProperties Extension properties for particular simulation engines (Radiance, EnergyPlus).
Type string [optional] [readonly] [default to "Model"]
Version string Text string for the current version of the schema. [optional] [default to "0.0.0"]
Buildings List<Building> A list of Buildings in the model. [optional]
ContextShades List<ContextShade> A list of ContextShades in the model. [optional]
Units Units Text indicating the units in which the model geometry exists. This is used to scale the geometry to the correct units for simulation engines like EnergyPlus, which requires all geometry be in meters. [optional]
Tolerance double The maximum difference between x, y, and z values at which vertices are considered equivalent. This value should be in the Model units and is used in a variety of checks and operations. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when checks have not already been performed on a Model. The default of 0.01 is suitable for models in meters. [optional] [default to 0.01D]
AngleTolerance double The max angle difference in degrees that vertices are allowed to differ from one another in order to consider them colinear. This value is used in a variety of checks and operations that can be performed on geometry. A value of 0 will result in no checks and an inability to perform certain operations so it is recommended that this always be a positive number when checks have not already been performed on a given Model. [optional] [default to 1.0D]

[Back to Model list] [Back to API list] [Back to README]