Struct LinkSpace 

pub struct LinkSpace<P = ()> { /* private fields */ }

Generic link-based network space.

Implementations

impl<P> LinkSpace<P>

pub fn new() -> Self

Create an empty link space with no nodes or links.

pub fn num_nodes(&self) -> usize

Number of nodes in the network.

pub fn num_links(&self) -> usize

Number of links in the network.

pub fn add_node(&mut self) -> NodeId

Add a node and return its index.

pub fn add_link( &mut self, from: NodeId, to: NodeId, geometry: LinkGeometry, properties: P, ) -> Result<LinkId, LinkSpaceError>

Add a directed link from from to to with geometry and per-link properties.

pub fn link_geometry(&self, link_id: LinkId) -> Option<&LinkGeometry>

Immutable access to link geometry.

pub fn link_geometry_mut( &mut self, link_id: LinkId, ) -> Option<&mut LinkGeometry>

Mutable access to link geometry.

pub fn link_properties(&self, link_id: LinkId) -> Option<&P>

Immutable access to per-link properties.

pub fn link_properties_mut(&mut self, link_id: LinkId) -> Option<&mut P>

Mutable access to per-link properties.

pub fn link_endpoints(&self, link_id: LinkId) -> Option<(NodeId, NodeId)>

Source and destination nodes of a link as (from, to).

pub fn outgoing_links(&self, node: NodeId) -> &[LinkId]

Outgoing link IDs from a node.

pub fn incoming_links(&self, node: NodeId) -> &[LinkId]

Incoming link IDs to a node.

pub fn agents_on_link(&self, link_id: LinkId) -> usize

Number of agents currently on a link.

pub fn agent_ids_on_link(&self, link_id: LinkId) -> &[AgentId]

Agent IDs currently on a link, ordered by position (upstream first).

pub fn link_length(&self, link_id: LinkId) -> Option<f64>

Link length in meters.

pub fn set_link_exit_blocked(&mut self, link_id: LinkId, blocked: bool)

Set whether a link’s exit is blocked by downstream logic.

pub fn link_exit_blocked(&self, link_id: LinkId) -> bool

Whether a link’s exit is currently blocked.

pub fn agent_position(&self, id: AgentId) -> Option<(LinkId, f64)>

Get an agent’s current link and position.

pub fn add_agent_to_link( &mut self, id: AgentId, link_id: LinkId, position: f64, ) -> Result<(), LinkSpaceError>

Place an agent on a link at a specific position.

pub fn remove_agent(&mut self, id: AgentId) -> Result<(), LinkSpaceError>

Remove an agent from the network.

pub fn advance_agent( &mut self, id: AgentId, distance: f64, ) -> Result<f64, LinkSpaceError>

Advance an agent’s position on its current link by distance meters.

pub fn agent_at_link_end(&self, id: AgentId) -> bool

Check if an agent has reached the downstream end of its link.

pub fn transfer_agent( &mut self, id: AgentId, to_link: LinkId, ) -> Result<(), LinkSpaceError>

Transfer an agent from the end of its current link to the start of a new link.

pub fn total_agents(&self) -> usize

Total number of agents in the network.

pub fn all_agent_ids(&self) -> Vec<AgentId>

All agent IDs in the network.

Trait Implementations

impl<P: Clone> Clone for LinkSpace<P>

fn clone(&self) -> LinkSpace<P>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P: Debug> Debug for LinkSpace<P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P> Default for LinkSpace<P>

fn default() -> Self

Returns the “default value” for a type.

impl<P: Send + Sync> Space for LinkSpace<P>