cad.simcad.objectserver.spec.pathfinding
Interface PathPlaceSet
- All Known Implementing Classes:
- Path
- public interface PathPlaceSet
A Set of PathPlace object, i.e. a path
Remember that a Path is computed according a PathUser caracteristics. That is why we have
the getPathUser() method.
- Version:
- 1.0
- Author:
- Charles-Philip Bentley
Method Summary |
java.util.Properties |
getComputingProperties()
Returns Properties related to the computation of the Path |
PathPlace |
getDest()
Returns the destination PathPlace of the path |
PathPlace |
getOrigin()
Returns the origin PathPlace of the path |
java.util.Enumeration |
getPathEnumDestFirst()
Enumeration of PathPlace Objects with Destination PathPlace first.
|
java.util.Enumeration |
getPathEnumOriginFirst()
Enumeration of PathPlace Objects with Origin PathPlace as first element in the emumeration.
|
PathUser |
getPathUser()
Return the PathUser walking this PathPlaceSet.
|
boolean |
isConsistent()
Check for path consistency
We define path consistence as follows : a path is consistent if from any
part of the path, there exists one and only one way to go to another part of the path
An empty path is not consistent |
getPathEnumOriginFirst
public java.util.Enumeration getPathEnumOriginFirst()
- Enumeration of PathPlace Objects with Origin PathPlace as first element in the emumeration.
If Path is not complete, the method returns an enumeration consisting of one PathPlace : the origin of the path
Returns the enumeration of PathPlaces making this Path. Origin is first
- Pre:
- -
- Returns:
- Enumeration of PathPlaces
- Post:
- PathPlaceSet is not modified
getPathEnumDestFirst
public java.util.Enumeration getPathEnumDestFirst()
- Enumeration of PathPlace Objects with Destination PathPlace first.
If Path is not complete, the method returns an enumeration consisting of one PathPlace : the destination of the path
- Pre:
- -
- Returns:
- Enumeration of PathPlaces
- Post:
- PathPlaceSet is not modified
getComputingProperties
public java.util.Properties getComputingProperties()
- Returns Properties related to the computation of the Path
- Returns:
- a Properties object. Null if no Properties have been computed
- Post:
- -Properties about the computation of the Path.
-null if no Properties have been computed
getDest
public PathPlace getDest()
- Returns the destination PathPlace of the path
- Pre:
- A PathPlaceSet always have an origin and destination. But it does not always have a consistent link between them.
- Returns:
- destination PathPlace
- Post:
- destination PathPlace of the PathPlaceSet
getOrigin
public PathPlace getOrigin()
- Returns the origin PathPlace of the path
- Pre:
- A PathPlaceSet always have an origin and destination. But it does not always have a consistent link between them.
- Returns:
- origin PathPlace
- Post:
- origin PathPlace of the PathPlaceSet
isConsistent
public boolean isConsistent()
- Check for path consistency
We define path consistence as follows : a path is consistent if from any
part of the path, there exists one and only one way to go to another part of the path
An empty path is not consistent
- Pre:
- -
- Returns:
- a boolean
- Post:
- true if the PathPlaceSet is complete. That is, we have on single way from the origin PathPlace to the destination PathPlace
getPathUser
public PathUser getPathUser()
- Return the PathUser walking this PathPlaceSet.
Remember that a Path is computed according a PathUser caracteristics.
- Pre:
- -
- Returns:
- PathUser
- Post:
- PathUser
With the help of www.sourceforge.net and www.info.ucl.ac.be