honeybee_ph.phius module

Phius Certification Data Class

class honeybee_ph.phius.PhiusBuildingCategoryType(_value: str | int = 1)

Bases: CustomEnum

ToString()

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

to_dict() → dict[str, Any]

allowed: list[str] = ['1-RESIDENTIAL BUILDING', '2-NON-RESIDENTIAL BUILDING']

property allowed_upper: list[str]

property number: int

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

property value: str

class honeybee_ph.phius.PhiusBuildingCertificationProgram(_value: str | int = 1)

Bases: CustomEnum

ToString()

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

to_dict() → dict[str, Any]

allowed: list[str] = ['1-Default', '2-PHIUS 2015', '3-PHIUS 2018', '4-Italian', '5-PHIUS 2018 CORE', '6-PHIUS 2018 ZERO', '7-PHIUS 2021 CORE', '8-PHIUS 2021 ZERO']

property allowed_upper: list[str]

property number: int

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

property value: str

class honeybee_ph.phius.PhiusBuildingStatus(_value: str | int = 1)

Bases: CustomEnum

ToString()

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

to_dict() → dict[str, Any]

allowed: list[str] = ['1-IN_PLANNING', '2-UNDER_CONSTRUCTION', '3-COMPLETE']

property allowed_upper: list[str]

property number: int

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

property value: str

class honeybee_ph.phius.PhiusBuildingType(_value: str | int = 1)

Bases: CustomEnum

ToString()

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

to_dict() → dict[str, Any]

allowed: list[str] = ['1-NEW_CONSTRUCTION', '2-RETROFIT', '3-MIXED']

property allowed_upper: list[str]

property number: int

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

property value: str

class honeybee_ph.phius.PhiusBuildingUseType(_value: str | int = 1)

Bases: CustomEnum

ToString()

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

to_dict() → dict[str, Any]

allowed: list[str] = ['1-RESIDENTIAL', '', '', '4-OFFICE/ADMINISTRATIVE BUILDING', '5-SCHOOL', '6-OTHER', '7-UNDEFINED/UNFINISHED']

property allowed_upper: list[str]

property number: int

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

property value: str

class honeybee_ph.phius.PhiusCertification

Bases: _Base

ToString()

duplicate() → PhiusCertification

classmethod from_dict(_dict: dict) → PhiusCertification

move(moving_vec3D: Vector3D) → PhiusCertification

Move the Phius Certification Object along a vector.

Parameters:

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

reflect(plane: Plane) → PhiusCertification

Reflected the Phius Certification Object across a plane.

Parameters:

normal_vec3D – A Plane representing the plane across which to reflect.

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

Rotate the Phius Certification Object by a certain angle around an axis and origin.

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

Parameters:

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

• angle_degrees – An angle for rotation in degrees.

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

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

Rotate the Phius Certification Object counterclockwise in the XY plane by a certain angle.

Parameters:

• angle_degrees – An angle in degrees.

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

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

Scale the Phius Certification Object by a factor from an origin point.

Parameters:

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

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

set_base_attrs_from_source(_source)

to_dict() → dict

property building_category_type: PhiusBuildingCategoryType

property building_status: PhiusBuildingStatus

property building_type: PhiusBuildingType

property building_use_type: PhiusBuildingUseType

property certification_program: PhiusBuildingCertificationProgram

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