Route
Osid Relationship
Aggregateable
A Route represents one or more paths
between two locations. A Route is created
from a series of RouteSegments which, in
turn, may relate to a Path. A
Path is an object representation of a
fixed means of travel between two locations, such as a
road.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidRelationship | |||
hasEndReason |
boolean | true if an end reason is available, false
otherwise |
|
endReasonId |
id | a state Id |
|
endReason |
State | a state | |
| Name | Syntax | Many | Description |
|---|---|---|---|
startingLocationId |
id | the starting location Id |
|
startingLocation |
Location | the starting location | |
endingLocationId |
id | the ending location Id |
|
endingLocation |
Location | the ending location | |
distance |
Distance | the total route distance | |
eTA |
duration | the estimated travel time | |
segmentIds |
id | ⋆ | the segment Ids of this route |
segments |
RouteSegment | ⋆ | the segments of this route |
Route Segment
Osid Object
A route segment represents a portion of a route.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Name | Syntax | Many | Description |
|---|---|---|---|
startingInstructions |
displaytext | the starting instructions | |
endingInstructions |
displaytext | the ending instructions | |
distance |
Distance | the distance | |
eTA |
duration | the estimated travel time | |
hasPath |
boolean | true if there is a path, false otherwise |
|
pathId |
id | the path | |
path |
Path | the path |
Route Progress
Osid Compendium
Route progress defines methods to get information about progress along a route.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| OsidCompendium | |||
startDate |
datetime | the date | |
endDate |
datetime | the date | |
isInterpolated |
boolean | true if this report is interpolated, false
otherwise |
|
isExtrapolated |
boolean | true if this report is extrapolated, false
otherwise |
|
| Name | Syntax | Many | Description |
|---|---|---|---|
resourceId |
id | the resource Id |
|
resource |
Resource | the resource | |
routeId |
id | the route Id |
|
route |
Route | the route | |
timeStarted |
datetime | the starting time | |
totalDistanceTraveled |
Distance | the distance | |
totalTravelTime |
duration | total travel time | |
isInMotion |
boolean | true if the object is in motion, false otherwise |
|
totalIdleTime |
duration | total idle time | |
timeLastMoved |
datetime | last moved time | |
isComplete |
boolean | true if the route has been completed, false
otherwise |
|
routeSegmentId |
id | the route segment Id |
|
routeSegment |
RouteSegment | the route segment | |
eTAToNextSegment |
duration | the estimated travel time | |
routeSegmentTraveled |
Distance | distance along the current segment traveled | |
timeCompleted |
datetime | the ending time |