dragonfly_trace.properties.model module

Model TACE Properties.

class dragonfly_trace.properties.model.ModelTraceProperties(host)[source]

Bases: object

TRACE Properties for Dragonfly Model.

Parameters:

host – A dragonfly_core Model object that hosts these properties.

Properties:

  • host

ToString()[source]
check_all(raise_exception=True, detailed=False)[source]

Check all of the aspects of the Model TRACE 3D Plus properties.

Parameters:

  • raise_exception – Boolean to note whether a ValueError should be raised if any errors are found. If False, this method will simply return a text string with all errors that were found.

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A text string with all errors that were found or a list if detailed is True. This string (or list) will be empty if no errors were found.

check_for_extension(raise_exception=True, detailed=False)[source]

Check that the Model is valid for TRACE 3D Plus simulation.

This process includes all relevant dragonfly-core checks as well as checks that apply only for TRACE 3D Plus.

Parameters:

  • raise_exception – Boolean to note whether a ValueError should be raised if any errors are found. If False, this method will simply return a text string with all errors that were found. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A text string with all errors that were found or a list if detailed is True. This string (or list) will be empty if no errors were found.

check_generic(raise_exception=True, detailed=False)[source]

Check generic of the aspects of the Model TRACE 3D Plus properties.

This includes checks for everything except holes in floor plates and courtyard stories.

Parameters:

  • raise_exception – Boolean to note whether a ValueError should be raised if any errors are found. If False, this method will simply return a text string with all errors that were found.

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A text string with all errors that were found or a list if detailed is True. This string (or list) will be empty if no errors were found.

check_no_room_2d_floor_plate_holes(raise_exception=True, detailed=False)[source]

Check whether any Room2D floor geometry has holes.

TRACE 3D Plus currently has no way to represent holes.

Parameters:

  • raise_exception – If True, a ValueError will be raised if the Room2D floor plate has one or more holes. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A string with the message or a list with a dictionary if detailed is True.

check_no_skylights(raise_exception=True, detailed=False)[source]

Check whether any Room2D floor geometry has skylights.

Parameters:

  • raise_exception – If True, a ValueError will be raised if a Room2D has skylights. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A string with the message or a list with a dictionary if detailed is True.

check_story_floor_plates(tolerance=None, raise_exception=True, detailed=False)[source]

Check Story floor plates for courtyards.

Parameters:

  • tolerance – The tolerance to be used when joining the Room2D floor plates together into a Story floor plate. If None, the Model tolerance will be used. (Default: None).

  • raise_exception – Boolean to note whether a ValueError should be raised if the story contains a courtyard. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A string with the message or a list with a dictionary if detailed is True.

check_windows_above_origin(tolerance=None, raise_exception=True, detailed=False)[source]

Check whether the Room2D has windows below the scene origin.

TRACE 3D Plus currently fails to import these windows since it believes that they are below ground.

Parameters:

  • tolerance – The maximum difference between coordinate values of two vertices at which they can be considered equivalent. (Default: 0.01, suitable for objects in meters).

  • raise_exception – Boolean to note whether a ValueError should be raised if the story contains a courtyard. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A string with the message or a list with a dictionary if detailed is True.

ERROR_MAP = {'040101': 'check_no_room_2d_floor_plate_holes', '040102': 'check_story_floor_plates', '040103': 'check_no_skylights', '040104': 'check_windows_above_origin'}
property host

Get the Model object hosting these properties.