Network (PLANitAllJava 0.2.0 API)

java.lang.Object
- org.djutils.event.EventProducer
- - org.planit.assignment.TrafficAssignmentComponent<Network>
  - - org.planit.network.Network

All Implemented Interfaces:

Serializable, Comparable<Idable>, org.djutils.event.EventProducerInterface, Idable

Direct Known Subclasses:

InfrastructureNetwork, VirtualNetwork
```
public class Network
extends TrafficAssignmentComponent<Network>
implements Serializable
```
Base class for any network. A network can be macroscopic or otherwise and in turn can be physical or not, etc. This all depends on its implementation. However in all cases it represents something that allows movement of one or more modes across the locations it represents.

Author:

markr

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`MACROSCOPIC_NETWORK`	shorthand for creating a macroscopic infrastructure network
`protected IdGroupingToken`	`networkIdGroupingToken`	a token for this network in particular to ensure unique ids across all entities of the same class instance within this network

Fields inherited from class org.planit.assignment.TrafficAssignmentComponent
id, tokenId, trafficComponentType

Fields inherited from class org.djutils.event.EventProducer
listeners

Fields inherited from interface org.djutils.event.EventProducerInterface
FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors
Constructor Description

Network(IdGroupingToken tokenId)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

IdGroupingToken getNetworkGroupingTokenId()
collect the grouping token for this network instance
- Methods inherited from class org.planit.assignment.TrafficAssignmentComponent
  equals, getId, getIdGroupingToken, getSourceId, getTrafficComponentType, hashCode
- Methods inherited from class org.djutils.event.EventProducer
  addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, getEventTypesWithListeners, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface org.planit.utils.id.Idable
  compareTo, idEquals, idHashCode

- Field Detail
  - networkIdGroupingToken
```
protected IdGroupingToken networkIdGroupingToken
```
    a token for this network in particular to ensure unique ids across all entities of the same class instance within this network
  - MACROSCOPIC_NETWORK
```
public static final String MACROSCOPIC_NETWORK
```
    shorthand for creating a macroscopic infrastructure network
- Constructor Detail
  - Network
```
public Network(IdGroupingToken tokenId)
```
    Constructor
    
    Parameters:
    
    tokenId - contiguous id generation within this group for instances of this class
- Method Detail
  - getNetworkGroupingTokenId
```
public IdGroupingToken getNetworkGroupingTokenId()
```
    collect the grouping token for this network instance
    
    Returns:
    
    id groupoing token