Package oracle.spatial.network.lod
Interface LogicalLightSubPath
-
- All Superinterfaces:
java.lang.Comparable
- All Known Subinterfaces:
LogicalSubPath
,SpatialSubPath
- All Known Implementing Classes:
LogicalSubPathImpl
,SpatialSubPathImpl
public interface LogicalLightSubPath extends java.lang.Comparable
Light weight logical sub-path that references to aLogicalLightPath
- Since:
- 11gR2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.Object
clone()
Support cloneableCategorizedUserData
getCategorizedUserData()
Returns categorized user data.double
getCost()
Deprecated.use getCosts();double[]
getCosts()
Returns the costs of the subpath.int
getEndLinkIndex()
Returns the end link index.double
getEndPercentage()
Returns the location of the end point of the subpath as a percentage of the last link of the containing path.LogicalLightPath
getReferenceLightPath()
Returns the path containing the subpath.int
getStartLinkIndex()
Returns the start link index.double
getStartPercentage()
Returns the location of the starting point of the subpath as a percentage of the first link of the containing path.UserData
getUserData(int category)
Returns user data for the specified category.boolean
isFullPath()
Returns true if the subpath covers the entire reference path.void
reverse()
Reverses the sub-path, and flip the isReverse flag of the reference path.void
setCategorizedUserData(CategorizedUserData userData)
Sets categorized user data.void
setCosts(double[] costs)
Sets the costs of the subpath.void
setEndLinkIndex(int endLinkIndex)
Sets the end link index.void
setEndPercentage(double endPercentage)
Sets the location of the end point of the subpath as a percentage of the last link of the containing path.void
setReferenceLightPath(LogicalLightPath refPath)
Sets the path containing the subpath.void
setStartLinkIndex(int startLinkIndex)
Sets the start link index.void
setStartPercentage(double startPercentage)
Sets the location of the starting point of the subpath as a percentage of the first link of the containing path.void
setUserData(int category, UserData userData)
Sets user data for the specified category.
-
-
-
Method Detail
-
getReferenceLightPath
LogicalLightPath getReferenceLightPath()
Returns the path containing the subpath.- Returns:
- the light weight logical path that contains the subpath
-
getStartPercentage
double getStartPercentage()
Returns the location of the starting point of the subpath as a percentage of the first link of the containing path.- Returns:
- location of the starting point on the start link
-
getEndPercentage
double getEndPercentage()
Returns the location of the end point of the subpath as a percentage of the last link of the containing path.- Returns:
- location of the end point on the end link
-
getStartLinkIndex
int getStartLinkIndex()
Returns the start link index.- Returns:
- the start link index
-
getEndLinkIndex
int getEndLinkIndex()
Returns the end link index.- Returns:
- the end link index
-
getCost
double getCost()
Deprecated.use getCosts();Returns the cost of the subpath.- Returns:
- cost of the subpath
-
getCosts
double[] getCosts()
Returns the costs of the subpath.- Returns:
- costs of the subpath
-
setReferenceLightPath
void setReferenceLightPath(LogicalLightPath refPath)
Sets the path containing the subpath.
-
setStartPercentage
void setStartPercentage(double startPercentage)
Sets the location of the starting point of the subpath as a percentage of the first link of the containing path.
-
setEndPercentage
void setEndPercentage(double endPercentage)
Sets the location of the end point of the subpath as a percentage of the last link of the containing path.
-
setStartLinkIndex
void setStartLinkIndex(int startLinkIndex)
Sets the start link index.
-
setEndLinkIndex
void setEndLinkIndex(int endLinkIndex)
Sets the end link index.
-
setCosts
void setCosts(double[] costs)
Sets the costs of the subpath.
-
isFullPath
boolean isFullPath()
Returns true if the subpath covers the entire reference path.- Returns:
- true if the subpath covers the entire reference path, false otherwise.
-
reverse
void reverse()
Reverses the sub-path, and flip the isReverse flag of the reference path. Similar to a path, a sub-path can be represented in the traveling direction, or in the reverse direction. When represented in reverse direction, the isReverse flag of its reference path is set to true.
-
getCategorizedUserData
CategorizedUserData getCategorizedUserData()
Returns categorized user data.- Returns:
-
setCategorizedUserData
void setCategorizedUserData(CategorizedUserData userData)
Sets categorized user data.- Parameters:
userData
-
-
getUserData
UserData getUserData(int category)
Returns user data for the specified category.- Returns:
-
setUserData
void setUserData(int category, UserData userData)
Sets user data for the specified category.- Parameters:
userData
-
-
clone
java.lang.Object clone() throws java.lang.CloneNotSupportedException
Support cloneable- Returns:
- cloned object
- Throws:
java.lang.CloneNotSupportedException
-
-