component

class pyrecodes.component.component.Bridge

Marker interface for bridge components. Use isinstance(component, Bridge) to identify bridges.

class pyrecodes.component.component.Component

Interface to define the required methods and properties of a component.

abstract construct(component_name: str, component_parameters: dict) → None

demand: dict

functional: list[int]

functionality_level: float

abstract get_damage_level() → float

abstract get_locality() → int

abstract has_operation_demand() → bool

abstract has_resource_supply(resource_name: str) → bool

locality: list

name: str

abstract recover(time_step: int) → None

abstract set_initial_damage_level(damage_level: float) → None

abstract set_locality(locality_id: list) → None

abstract set_met_demand_for_recovery_activities(resource_name: str, percent_of_met_demand: float) → None

abstract set_recovery_time_steps(recovery_time_steps: list) → None

supply: dict

abstract update(time_step: int, *args) → None

abstract update_supply_based_on_unmet_demand(percent_of_met_demand: float, resource_name: str, time_step: int) → None

class pyrecodes.component.component.Roadway

Marker interface for roadway components. Use isinstance(component, Roadway) to identify roadways.

class pyrecodes.component.component.SupplyOrDemand(value)

Enum Class to specify the strings used for component’s supply and demand attributes.

DEMAND = 'demand'

SUPPLY = 'supply'

class pyrecodes.component.component.Tunnel

Marker interface for tunnel components. Use isinstance(component, Tunnel) to identify tunnels.