OSMEnvironment
This class serves as a template for more specific implementations of environments using a map. It encloses the navigation logic but leaves the subclasses to decide how to provide map data (e.g., loading from disk or relying on online services). The data is then stored in-memory for performance reasons.
Parameters
concentration type
Constructors
Properties
Functions
Registers reaction and notifies the running simulation when it was not already present. Fails if this is not the Reaction.host of reaction.
Add a terminator indicating whether the simulation should be considered finished. The simulation finishes as soon as any of the terminators is satisfied.
Adds to the simulation a predicate that determines whether a simulation should be terminated.
Calculates the shortest paths using the Floyd-Warshall algorithm calculating the Hop Distance between nodes.
Computes the diameter of all subnetworks in the environment. The diameter is the longest shortest path between any two nodes. Returns a Map mapping each node to the subnetwork it belongs to.
Computes the diameter of all subnetworks in the environment. The diameter is the longest shortest path between any two nodes, evaluated using the allShortestHopPaths method. Returns a Set containing the subnetworks.
Computes the diameter of all subnetworks in the environment. The diameter is the longest shortest path between any two nodes, evaluated using the allShortestHopPaths method. Returns a Set containing the subnetworks.
Retrieves node's current position.
The distance between this node and other, see distanceBetween.
The farthest position that node reaches moving straight from its current position towards desired: desired itself, unless the constraints of this environment, such as its bounds, its obstacles, or the bodies of the other nodes, stop node earlier. moveNodeTo moves nodes to this position.
Movements are unconstrained: subclasses constraining them override this function, starting from the position that it returns.
The current position of this node, see currentPositionOf.
Return the Incarnation used to initialize the entities of this Environment, if it has been set.
The observable neighborhood of this node, see neighborhoodOf.
The current NetworkModel, which must be bound to this environment. Assigning a new model publishes the neighborhood it provides for every node in the environment.
Returns an Observable view of the number of Nodes currently in the Environment.
An ordered Observable view of all the Nodes that exist in current Environment.
The observable position of this node, see positionOf.
The reactions registered with this host, in registration order; ObservableList.current is a snapshot.
Return the current Simulation, if present, or throws an IllegalStateException otherwise.
Return the current Simulation, if present, or null otherwise.
Returns true the network is segmented, false otherwise.
Whether any of the terminators is satisfied.
Moves node to the farthestReachablePosition towards position, extending the environment to include it.
Given a node, this method returns an observable view of its neighborhood.
Returns the diameter of the network in environment units if it is not segmented, and NaN otherwise.
Given a node this method returns a list of all the surrounding nodes within the given range. Note that this method (depending on the implementation) might be not optimized, and it's consequently much better to use Environment.neighborhoodOf and filter the neighborhood if you are sure that all the nodes within the range are connected to the center.
The nodes within range of this node, see nodesAround.
Allows accessing a Node in this Environment known its id. Depending on the implementation, this method may or may not be optimized (namely, id could run in constant or linear time with the number of nodes).
Observes the value of the Layer associated with molecule at the position of node. The observable emits when node moves to a position where the value differs, and when the layer changes the value at the current position of node. Its value is null while no layer is associated with molecule, and it emits when one is: observables created during setup follow layers associated later.
An Observable alternative to nodesAround.
Observes the nodes within range of this node, see observeNodesAround.
Observe the position of a node.
Removes this node, see removeNode.
Removes node. If node removal is unsupported, it does nothing.
Unregisters reaction and notifies the running simulation when it was actually present.
The current NetworkModel, which must be bound to this environment. Assigning a new model publishes the neighborhood it provides for every node in the environment.
Return the current Simulation, if present, or throws an IllegalStateException otherwise.
Returns the EnvironmentSubscriptionMonitor of this Environment.
A function that maps an Environment to its surrogate class (EnvironmentSurrogate). Use the toSuitablePositionSurrogate strategy for PositionSurrogate mapping.
A function that maps an Environment to its surrogate class (EnvironmentSurrogate).
Converts an Environment to a EnvironmentSurrogate.
A position with these coordinates, see makePosition.