SSF.OS.OSPFv2
Class RouterEntry

java.lang.Object
  |
  +--SSF.OS.OSPFv2.RouterEntry

public class RouterEntry
extends java.lang.Object

A routing table entry describing the set of shortest paths leading to a router destination. Also included is the optional capability field of the router. All other values of these entries are encoded in the OSPFv2 Routing Table structure.


Field Summary
 int cost
          The link state cost of the paths to the router.
 java.util.Vector equalCostPaths
          A Vector holding all equal-cost paths in form of ShortestPath objects.
 boolean isASBoundary
          A boolean value, indicating that the route destination is an AS boundary router.
 Router_LSA lsOrigin
          In case of path-type INTRA_AREA this field references the LSA that directly references the destination.
 boolean[] optCap
          The optional OSPF capabilities supported by the destination router.
 byte pathType
          The type of path of the set of shortest paths to the destination router.
 
Constructor Summary
RouterEntry(boolean[] opt, byte pType, int c, Router_LSA lso, boolean isASB, java.util.Vector paths)
          Constructs a new RouterEntry and set the fields to the given values.
 
Method Summary
 boolean equals(java.lang.Object routEntObj)
          Compare this RouterEntry with another one.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

optCap

public boolean[] optCap
The optional OSPF capabilities supported by the destination router.


pathType

public byte pathType
The type of path of the set of shortest paths to the destination router. The values of pathType are specified in class OSPF.


cost

public int cost
The link state cost of the paths to the router.


lsOrigin

public Router_LSA lsOrigin
In case of path-type INTRA_AREA this field references the LSA that directly references the destination. Here the destination is a router, so the value may only be a ROUTER_LSA.


isASBoundary

public boolean isASBoundary
A boolean value, indicating that the route destination is an AS boundary router.


equalCostPaths

public java.util.Vector equalCostPaths
A Vector holding all equal-cost paths in form of ShortestPath objects.

Constructor Detail

RouterEntry

public RouterEntry(boolean[] opt,
                   byte pType,
                   int c,
                   Router_LSA lso,
                   boolean isASB,
                   java.util.Vector paths)
Constructs a new RouterEntry and set the fields to the given values.

Parameters:
opt - The destination router's optional capabilities.
pType - The path type of the set of shortest paths (see class OSPF).
c - The cost of the shortest paths.
lso - Router-LSA describing the LS Origin (currently not used in any calculations).
isASB - boolean value indicating an AS boundary destination.
paths - A Vector holding ShortestPath objects which uniquely identifies the various shortest paths.
Method Detail

equals

public boolean equals(java.lang.Object routEntObj)
Compare this RouterEntry with another one. Return true if they are equal else false.

Overrides:
equals in class java.lang.Object
Parameters:
routEntObj - RouterEntry to compare.
Returns:
boolean value indicating whether the two entries are equal or not.