com.anylogic.engine.markup

Interface INetwork<N extends INode<N,P>,P extends IPath<N>>

Type Parameters:

N - network node, an instance of INode

P - network path, an instance of IPath

All Superinterfaces:

IRouteProvider<ShortestPathData<N,P>>, java.io.Serializable

All Known Implementing Classes:

AbstractNetwork, ConveyorNetwork, GISNetwork, Network

public interface INetwork<N extends INode<N,P>,P extends IPath<N>>
extends IRouteProvider<ShortestPathData<N,P>>

Basic interface of network for agent movement based on markup elements.

Author:

AnyLogic North America, LLC https://anylogic.com

Method Summary

Modifier and Type	Method and Description
void	add(N n) Adds node to network.
void	add(P p) Adds relation to network.
java.lang.Class<? extends ExtAgentWithSpatialMetrics>	getCompatibleAgentExtensionClass() This method is internal and shouldn't be called by user.
double	getDistance(N from, N to, ShortestPathData<N,P> data)
double	getDistance(N from, N to, ShortestPathData<N,P> data, LengthUnits units)
double	getDistance(N from, P to, double toOffset, ShortestPathData<N,P> data)
double	getDistance(N from, P to, double toOffset, ShortestPathData<N,P> data, LengthUnits units)
double	getDistance(P from, double fromOffset, N to, ShortestPathData<N,P> data)
double	getDistance(P from, double fromOffset, N to, ShortestPathData<N,P> data, LengthUnits units)
double	getDistance(P from, double fromOffset, P to, double toOffset, ShortestPathData<N,P> data)
double	getDistance(P from, double fromOffset, P to, double toOffset, ShortestPathData<N,P> data, LengthUnits units)
double	getDistance(Point source, Point target, N from, N to, ShortestPathData<N,P> data)
double	getDistance(Point source, Point target, N from, N to, ShortestPathData<N,P> data, LengthUnits units)
double	getDistance(Point source, Point target, N from, P to, double toOffset, ShortestPathData<N,P> data)
double	getDistance(Point source, Point target, N from, P to, double toOffset, ShortestPathData<N,P> data, LengthUnits units)
double	getDistance(Point source, Point target, P from, double fromOffset, N to, ShortestPathData<N,P> data)
double	getDistance(Point source, Point target, P from, double fromOffset, N to, ShortestPathData<N,P> data, LengthUnits units)
double	getDistance(Point source, Point target, P from, double fromOffset, P to, double toOffset, ShortestPathData<N,P> data)
double	getDistance(Point source, Point target, P from, double fromOffset, P to, double toOffset, ShortestPathData<N,P> data, LengthUnits units)
double	getDistance(Point source, Point target, ShortestPathData<N,P> data)
double	getDistance(Point source, Point target, ShortestPathData<N,P> data, LengthUnits units)
N	getNearestNode(Point p) Looking for the closest node in this network to the given point.
N	getNode(int index)
int	getNodeCount() Amount of nodes in this network.
P	getPath(int index)
int	getPathCount() Amount of paths in this network.
double	getPlainDistance(Point firstPoint, Point secondPoint) Straight line distance between two points.
double	getPlainDistance(Point firstPoint, Point secondPoint, LengthUnits units) Straight line distance between two points in given units of length.
Position	getPosition(ShortestPathData<N,P> data, double reverseOffset, LengthUnits units, Position out) Calculates current position on the shortest path through network by the given offset
Position	getPosition(ShortestPathData<N,P> data, double reverseOffset, Position out) Calculates current position on the shortest path through network by the given offset
Agent	getSpace() Returns the space where the markup element is defined
java.util.List<N>	nodes()
java.util.List<P>	paths()

Methods inherited from interface com.anylogic.engine.IRouteProvider

getDistance, getLength, getPathData, getPositionAtOffset

Method Detail

add

void add(N n)

Adds node to network. Don't call this method when network has been initialized.

Parameters:

n - network node, instance of INode

add

void add(P p)

Adds relation to network. Don't call this method when network has been initialized.

Parameters:

p - network path, instance of IPath

getNearestNode

N getNearestNode(Point p)

Looking for the closest node in this network to the given point.

Parameters:

p - the given point

Returns:

getNode

N getNode(int index)

getNodeCount

int getNodeCount()

Amount of nodes in this network.

Returns:

amount of nodes

getPath

P getPath(int index)

getPathCount

int getPathCount()

Amount of paths in this network.

Returns:

amount of paths

nodes

java.util.List<N> nodes()

Returns:

all nodes of this network

paths

java.util.List<P> paths()

Returns:

all paths of this network

getDistance

double getDistance(N from,
                   N to,
                   ShortestPathData<N,P> data)

getDistance

double getDistance(N from,
                   N to,
                   ShortestPathData<N,P> data,
                   LengthUnits units)

getDistance

double getDistance(N from,
                   P to,
                   double toOffset,
                   ShortestPathData<N,P> data)

getDistance

double getDistance(N from,
                   P to,
                   double toOffset,
                   ShortestPathData<N,P> data,
                   LengthUnits units)

getDistance

double getDistance(P from,
                   double fromOffset,
                   N to,
                   ShortestPathData<N,P> data)

getDistance

double getDistance(P from,
                   double fromOffset,
                   N to,
                   ShortestPathData<N,P> data,
                   LengthUnits units)

getDistance

double getDistance(P from,
                   double fromOffset,
                   P to,
                   double toOffset,
                   ShortestPathData<N,P> data)

getDistance

double getDistance(P from,
                   double fromOffset,
                   P to,
                   double toOffset,
                   ShortestPathData<N,P> data,
                   LengthUnits units)

getDistance

double getDistance(Point source,
                   Point target,
                   N from,
                   N to,
                   ShortestPathData<N,P> data)

getDistance

double getDistance(Point source,
                   Point target,
                   N from,
                   N to,
                   ShortestPathData<N,P> data,
                   LengthUnits units)

getDistance

double getDistance(Point source,
                   Point target,
                   N from,
                   P to,
                   double toOffset,
                   ShortestPathData<N,P> data)

getDistance

double getDistance(Point source,
                   Point target,
                   N from,
                   P to,
                   double toOffset,
                   ShortestPathData<N,P> data,
                   LengthUnits units)

getDistance

double getDistance(Point source,
                   Point target,
                   P from,
                   double fromOffset,
                   N to,
                   ShortestPathData<N,P> data)

getDistance

double getDistance(Point source,
                   Point target,
                   P from,
                   double fromOffset,
                   N to,
                   ShortestPathData<N,P> data,
                   LengthUnits units)

getDistance

double getDistance(Point source,
                   Point target,
                   P from,
                   double fromOffset,
                   P to,
                   double toOffset,
                   ShortestPathData<N,P> data)

getDistance

double getDistance(Point source,
                   Point target,
                   P from,
                   double fromOffset,
                   P to,
                   double toOffset,
                   ShortestPathData<N,P> data,
                   LengthUnits units)

getDistance

double getDistance(Point source,
                   Point target,
                   ShortestPathData<N,P> data)

getDistance

double getDistance(Point source,
                   Point target,
                   ShortestPathData<N,P> data,
                   LengthUnits units)

getPlainDistance

double getPlainDistance(Point firstPoint,
                        Point secondPoint)

Straight line distance between two points.

Parameters:

firstPoint -

secondPoint -

Returns:

distance between two points

getPlainDistance

double getPlainDistance(Point firstPoint,
                        Point secondPoint,
                        LengthUnits units)

Straight line distance between two points in given units of length.

Parameters:

firstPoint -

secondPoint -

units - unit of length

Returns:

distance between two points

getPosition

Position getPosition(ShortestPathData<N,P> data,
                     double reverseOffset,
                     Position out)

Calculates current position on the shortest path through network by the given offset

Parameters:

data - shortest path data, see #getDistance(Node, Node, ShortestPathData) methods

reverseOffset - offset from the end of route

out - the Position object to use for output, may be null

Returns:

the position on the shortest path

getPosition

Position getPosition(ShortestPathData<N,P> data,
                     double reverseOffset,
                     LengthUnits units,
                     Position out)

Calculates current position on the shortest path through network by the given offset

Parameters:

data - shortest path data, see #getDistance(Node, Node, ShortestPathData) methods

reverseOffset - offset from the end of route

units - the units of length

out - the Position object to use for output, may be null

Returns:

the position on the shortest path

Since:

7.1

getSpace

Agent getSpace()

Returns the space where the markup element is defined

Returns:

the space associated with this element

getCompatibleAgentExtensionClass

@AnyLogicInternalAPI
java.lang.Class<? extends ExtAgentWithSpatialMetrics> getCompatibleAgentExtensionClass()

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.