dragonfly_energy.opendss.road module

Road along which RNM will place electrical connectors.

class dragonfly_energy.opendss.road.Road(identifier, geometry)[source]

Bases: _GeometryBase

Represents a road along which RNM will place electrical connectors.

Parameters:

  • identifier – Text string for a unique road ID. Must contain only characters that are acceptable in RNM and OpenDSS. This will be used to identify the object across the exported geoJSON, RNM and OpenDSS files.

  • geometry – A LineSegment2D or Polyline2D representing the geometry of the road.

Properties:

  • identifier

  • display_name

  • geometry

ToString()
duplicate()

Get a copy of this object.

classmethod from_dict(data)[source]

Initialize a Road from a dictionary.

Parameters:

data – A dictionary representation of a Road object.

move(moving_vec)

Move this object along a vector.

Parameters:

moving_vec – A ladybug_geometry Vector3D with the direction and distance to move the object.

reflect(plane)

Reflect this object across a plane.

Parameters:

plane – A ladybug_geometry Plane across which the object will be reflected.

rotate_xy(angle, origin)

Rotate this object counterclockwise in the XY plane by a certain angle.

Parameters:

  • angle – An angle in degrees.

  • origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.

scale(factor, origin=None)

Scale this object by a factor from an origin point.

Parameters:

  • factor – A number representing how much the object should be scaled.

  • origin – A ladybug_geometry Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

to_dict()[source]

Road dictionary representation.

to_geojson_dict(origin_lon_lat, conversion_factors)[source]

Get Road dictionary as it appears in an URBANopt geoJSON.

Parameters:

  • origin_lon_lat – An array of two numbers in degrees. The first value represents the longitude of the scene origin in degrees (between -180 and +180). The second value represents latitude of the scene origin in degrees (between -90 and +90). Note that the “scene origin” is the (0, 0) coordinate in the 2D space of the input polygon.

  • conversion_factors – A tuple with two values used to translate between meters and longitude, latitude.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property geometry

Get a LineSegment2D or Polyline2D representing the road geometry.

property identifier

Get or set the text string for unique object identifier.