Skip to main content
`Ctrl`+`K`

# aequilibrae.project.network.Link

class aequilibrae.project.network.Link(dataset, project)

  A Link object represents a single record in the links table

      >>> project = create_example(project_path)

      >>> all_links = project.network.links

      # Let's get a mode to work with
      >>> modes = project.network.modes
      >>> car_mode = modes.get('c')

      # We can just get one link in specific
      >>> link1 = all_links.get(3)
      >>> link2 = all_links.get(17)

      # We can find out which fields exist for the links
      >>> which_fields_do_we_have = link1.data_fields()

      # And edit each one like this
      >>> link1.lanes_ab = 3
      >>> link1.lanes_ba = 2

      # we can drop a mode from the link
      >>> link1.drop_mode(car_mode)  # or link1.drop_mode('c')

      # we can add a mode to the link
      >>> link2.add_mode(car_mode)  # or link2.add_mode('c')

      # Or set all modes at once
      >>> link2.set_modes('cbtw')

      # We can just save the link
      >>> link1.save()
      >>> link2.save()

  __init__(dataset, project)

  Methods

  `__init__`(dataset, project) |
  `add_mode`(mode) | Adds a new mode to this link
  `connect_db`() |
  `data_fields`() | lists all data fields for the link, as available in the database
  `delete`() | Deletes link from database
  `drop_mode`(mode) | Removes a mode from this link
  `save`() | Saves link to database
  `set_modes`(modes) | Sets the modes acceptable for this link

  add_mode(mode: str | Mode)

    Adds a new mode to this link

    Raises a warning if mode is already allowed on the link, and fails if mode does not exist

    Arguments:

      mode_id (`str` or Mode): Mode_id of the mode or mode object to be added to the link

  connect_db()
  data_fields() → list

    lists all data fields for the link, as available in the database

    Returns:

      data fields (`list`): list of all fields available for editing

  delete()

    Deletes link from database

  drop_mode(mode: str | Mode)

    Removes a mode from this link

    Raises a warning if mode is already NOT allowed on the link, and fails if mode does not exist

    Arguments:

      mode_id (`str` or Mode): Mode_id of the mode or mode object to be removed from the link

  save()

    Saves link to database

  set_modes(modes: str)

    Sets the modes acceptable for this link

    Arguments:

      modes (`str`): string with all mode_ids to be assigned to this link