ifcopenshell.api.sequence.edit_recurrence_pattern

Module Contents

ifcopenshell.api.sequence.edit_recurrence_pattern.edit_recurrence_pattern(file: ifcopenshell.file, recurrence_pattern: ifcopenshell.entity_instance, attributes: dict[str, Any]) → None

Edits the attributes of an IfcRecurrencePattern

For more information about the attributes and data types of an IfcRecurrencePattern, consult the IFC documentation.

Parameters:

• recurrence_pattern (ifcopenshell.entity_instance) – The IfcRecurrencePattern entity you want to edit

• attributes (dict) – a dictionary of attribute names and values.

Returns:

None

Return type:

None

Example:

# Let's create a new calendar.
calendar = ifcopenshell.api.sequence.add_work_calendar(model)

# Let's start defining the times that we work during the week.
work_time = ifcopenshell.api.sequence.add_work_time(model,
    work_calendar=calendar, time_type="WorkingTimes")

# We create a weekly recurrence
pattern = ifcopenshell.api.sequence.assign_recurrence_pattern(model,
    parent=work_time, recurrence_type="WEEKLY")

# State that we work from weekdays 1 to 5 (i.e. Monday to Friday)
ifcopenshell.api.sequence.edit_recurrence_pattern(model,
    recurrence_pattern=pattern, attributes={"WeekdayComponent": [1, 2, 3, 4, 5]})