dragonfly_uwg.properties.context module

Context Shade UWG Properties.

class dragonfly_uwg.properties.context.ContextShadeUWGProperties(host_shade, is_vegetation=False)[source]

Bases: object

UWG Properties for Dragonfly ContextShade.

Parameters

  • host_shade – A dragonfly_core ContextShade object that hosts these properties.

  • is_vegetation – Boolean to note whether the shade represents a tree canopy, in which case, it will be incorporated into the simulation as tree cover. (Default: False).

Properties:

  • host

  • is_vegetation

ToString()[source]
apply_properties_from_dict(abridged_data)[source]

Apply properties from a ContextShadeUWGPropertiesAbridged dictionary.

Parameters

abridged_data – A ContextShadeUWGPropertiesAbridged dictionary (typically coming from a Model).

duplicate(new_host=None)[source]

Get a copy of this object.

new_host: A new ContextShade object that hosts these properties.

If None, the properties will be duplicated with the same host.

classmethod from_dict(data, host)[source]

Create ContextShadeUWGProperties from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

  • data – A dictionary representation of ContextShadeUWGProperties.

  • host – A ContextShade object that hosts these properties.

to_dict(abridged=False)[source]

Return UWG properties as a dictionary.

Parameters

abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True). Default: False.

property host

Get the Shade object hosting these properties.

property is_vegetation

Get or set a boolean for whether the shade represents a tree canopy.