aequilibrae.project.network.Links

class aequilibrae.project.network.Links(net)

Access to the API resources to manipulate the links table in the network

>>> project = create_example(project_path)

>>> all_links = project.network.links

# We can just get one link in specific
>>> link = all_links.get(1)

# We can save changes for all links we have edited so far
>>> all_links.save()

__init__(net)

Methods

__init__(net)
copy_link(link_id)	Creates a copy of a link with a new id
delete(link_id)	Removes the link with link_id from the project
extent()	Queries the extent of the layer included in the model
get(link_id)	Get a link from the network by its link_id
new()	Creates a new link
refresh()	Refreshes all the links in memory
refresh_fields()	After adding a field one needs to refresh all the fields recognized by the software
save()

Attributes

data	Returns all links data as a Pandas DataFrame
fields	Returns a FieldEditor class instance to edit the zones table fields and their metadata
sql	Query sql for retrieving links

copy_link(link_id: int) → Link

Creates a copy of a link with a new id

It raises an error if link_id does not exist

Arguments:

link_id (int): Id of the link to copy

Returns:

link (Link): Link object for requested link_id

delete(link_id: int) → None

Removes the link with link_id from the project

Arguments:

link_id (int): Id of a link to delete

extent() → Polygon

Queries the extent of the layer included in the model

Returns:

model extent (Polygon): Shapely polygon with the bounding box of the layer.

get(link_id: int) → Link

Get a link from the network by its link_id

It raises an error if link_id does not exist

Arguments:

link_id (int): Id of a link to retrieve

Returns:

link (Link): Link object for requested link_id

new() → Link

Creates a new link

Returns:

link (Link): A new link object populated only with link_id (not saved in the model yet)

refresh()

Refreshes all the links in memory

refresh_fields() → None

After adding a field one needs to refresh all the fields recognized by the software

save()

property data: GeoDataFrame

Returns all links data as a Pandas DataFrame

Returns:

table (GeoDataFrame): GeoPandas GeoDataFrame with all the nodes

property fields: FieldEditor

Returns a FieldEditor class instance to edit the zones table fields and their metadata

sql = ''

Query sql for retrieving links