honeybee_ph.bldg_segment module

Building ‘Segment’ Level Data Attributes

class honeybee_ph.bldg_segment.BldgSegment

Bases: _Base

ToString()

add_new_thermal_bridge(tb: PhThermalBridge) → None

duplicate()

classmethod from_dict(_dict: Dict[str, Any]) → BldgSegment

move(moving_vec3D: Vector3D) → BldgSegment

Move the BldgSegment along a vector.

Parameters:

moving_vec3D – A Vector3D with the direction and distance to move the ray.

reflect(plane: Plane) → BldgSegment

Reflected the BldgSegment across a plane with the input normal vector and origin_pt3D.

Parameters:

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

rotate(axis_vec3D: Vector3D, angle_degrees: float, origin_pt3D: Point3D) → BldgSegment

Rotate the BldgSegment by a certain angle around an axis_vec3D and origin_pt3D.

Right hand rule applies: If axis_vec3D has a positive orientation, rotation will be clockwise. If axis_vec3D has a negative orientation, rotation will be counterclockwise.

Parameters:

• axis_vec3D – A Vector3D axis_vec3D representing the axis_vec3D of rotation.

• angle_degrees – An angle for rotation in degrees.

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

rotate_xy(angle_degrees: float, origin_pt3D: Point3D) → BldgSegment

Rotate the BldgSegment counterclockwise in the XY plane by a certain angle.

Parameters:

• angle_degrees – An angle in degrees.

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

scale(scale_factor: float, origin_pt3D: Point3D | None = None) → BldgSegment

Scale the BldgSegment a factor from an origin_pt3D point.

Parameters:

• scale_factor – A number representing how much the line segment should be scaled.

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

set_base_attrs_from_source(_source)

to_dict() → Dict[str, Any]

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 identifier

property identifier_short

class honeybee_ph.bldg_segment.PhVentilationSummerBypassMode(_value: str | int = 1)

Bases: CustomEnum

ToString()

classmethod from_dict(_dict: dict[str, Any]) → CustomEnum

to_dict() → dict[str, Any]

allowed: list[str] = ['1-None', '2-Temperature Controlled', '3-Enthalpy Controlled', '4-Always']

property allowed_upper: list[str]

property number: int

Returns the index pos of self.value (usually 1-based)

property value: str

class honeybee_ph.bldg_segment.PhWindExposureType(_value: str | int = 1)

Bases: CustomEnum

ToString()

classmethod from_dict(_dict: dict[str, Any]) → CustomEnum

to_dict() → dict[str, Any]

allowed: list[str] = ['1-SEVERAL_SIDES_EXPOSED_NO_SCREENING', '2-SEVERAL_SIDES_EXPOSED_MODERATE_SCREENING', '3-SEVERAL_SIDES_EXPOSED_HIGH_SCREENING', '4-ONE_SIDE_EXPOSED_NO_SCREENING', '5-ONE_SIDE_EXPOSED_MODERATE_SCREENING', '6-USER_DEFINED', '7-ONE_SIDE_EXPOSED_HIGH_SCREENING']

property allowed_upper: list[str]

property number: int

Returns the index pos of self.value (usually 1-based)

property value: str

class honeybee_ph.bldg_segment.SetPoints

Bases: _Base

ToString()

duplicate() → SetPoints

classmethod from_dict(_dict: Dict[str, Any]) → SetPoints

set_base_attrs_from_source(_source)

to_dict() → Dict[str, float]

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 identifier

property identifier_short