Package org.osid.mapping.path

The Open Service Interface Definitions for the org.osid.mapping.path service.

See: Description

Interface Summary

Interface	Description
Intersection	An intersection represents a crossing of paths where one can travel from one path to another.
IntersectionAdminSession	This session creates, updates, and deletes Intersections.
IntersectionForm	This is the form for creating and updating Routes.
IntersectionList	Like all OsidLists, IntersectionList provides a means for accessing Intersection elements sequentially either one at a time or many at a time.
IntersectionLookupSession	This session provides methods for retrieving Intersections.
IntersectionMapAssignmentSession	This session provides methods to re-assign Intersections to Map objects.
IntersectionMapSession	This session provides methods to retrieve Intersection to Map mappings.
IntersectionNotificationSession	This session defines methods to receive notifications on adds/changes to Intersection objects in this Map.
IntersectionQuery	This is the query for searching intersections.
IntersectionQueryInspector	This is the query inspector for examining intersection queries.
IntersectionQuerySession	This session provides methods for searching among Intersection objects.
IntersectionReceiver	The path receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Intersection objects.
IntersectionSearch	The search interface for governing intersection searches.
IntersectionSearchOrder	An interface for specifying the ordering of search results.
IntersectionSearchResults	This interface provides a means to capture results of a search.
IntersectionSearchSession	This session provides methods for searching among Intersection objects.
IntersectionSmartMapSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
MappingPathManager	The mapping path manager provides access to path sessions and provides interoperability tests for various aspects of this service.
MappingPathProfile	The mapping profile describes the interoperability among mapping services.
MappingPathProxyManager	The mapping proxy manager provides access to rules sessions and provides interoperability tests for various aspects of this service.
MyPathSession	This session defines methods to get path information for the authenticated agent.
Obstacle	A Obstacle represents a blockage along a Path.
ObstacleAdminSession	This session creates, updates, and deletes Obstacles.
ObstacleForm	This is the form for creating and updating Obstacles.
ObstacleList	Like all OsidLists, ObstacleList provides a means for accessing Obstacle elements sequentially either one at a time or many at a time.
ObstacleLookupSession	This session defines methods for retrieving obstacle.
ObstacleMapAssignmentSession	This session provides methods to re-assign Obstacles to Map objects An Obstacle may appear in multiple Map objects and removing the last reference to an Obstacle is the equivalent of deleting it.
ObstacleMapSession	This session provides methods to retrieve Obstacle to Map mappings.
ObstacleNotificationSession	This session defines methods to receive notifications on adds/changes to Obstacle objects in this Map.
ObstacleQuery	This is the query for searching obstacles.
ObstacleQueryInspector	This is the query inspecto for examining obstacle queries.
ObstacleQuerySession	This session provides methods for searching among Obstacle objects.
ObstacleReceiver	The obstacle receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted obstacle.
ObstacleSearch	The search interface for governing obstacle searches.
ObstacleSearchOrder	An interface for specifying the ordering of search results.
ObstacleSearchResults	This interface provides a means to capture results of a search.
ObstacleSearchSession	This session provides methods for searching among Obstacle objects.
ObstacleSmartMapSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Path	A Path represents a navigable path or road.
PathAdminSession	This session creates, updates, and deletes Paths.
PathForm	This is the form for creating and updating Paths.
PathList	Like all OsidLists, PathList provides a means for accessing Path elements sequentially either one at a time or many at a time.
PathLookupSession	This session provides methods for retrieving Path objects.
PathMapAssignmentSession	This session provides methods to re-assign Paths to Map objects.
PathMapSession	This session provides methods to retrieve Path to Map mappings.
PathNotificationSession	This session defines methods to receive notifications on adds/changes to Path objects in this Map.
PathQuery	This is the query for searching paths.
PathQueryInspector	This is the query inspector for examining path queries.
PathQuerySession	This session provides methods for searching among Path objects.
PathReceiver	The path receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Path objects.
PathSearch	The search interface for governing path searches.
PathSearchOrder	An interface for specifying the ordering of search results.
PathSearchResults	This interface provides a means to capture results of a search.
PathSearchSession	This session provides methods for searching among Path objects.
PathSmartMapSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
PathSpatialDesignSession	This session defines methods for designing paths.
PathSpatialSession	This session defines methods for retrieving paths through spatial queries.
PathTravelSession	This session provides methods for examining Path travel.
ResourcePathNotificationSession	This session defines methods to receive notifications on adds/changes to resources on paths in this Map.
ResourcePathReceiver	The resource route receiver is the consumer supplied interface for receiving notifications pertaining to changes of resources along paths.
ResourceSignalNotificationSession	This session defines methods to receive notifications for signal crossings in this Map.
ResourceSignalReceiver	The resource route receiver is the consumer supplied interface for receiving notifications pertaining to signal crossings by resources.
ResourceVelocity	A Velocity for a Resource.
ResourceVelocityList	Like all OsidLists, ResourceVelocityList provides a means for accessing ResourceVelocity elements sequentially either one at a time or many at a time.
ResourceVelocityNotificationSession	This session defines methods to receive notifications on adds/changes to resource velocities in this Map.
ResourceVelocityReceiver	The resource route receiver is the consumer supplied interface for receiving notifications pertaining to changes of resource velocities.
ResourceVelocitySession	This session defines methods to look up resources on paths.
ResourceVelocityUpdateSession	This session defines methods to update resource velocities.
Signal	A Signal represents a traffic signal in a Map.
SignalAdminSession	This session creates, updates, and deletes Signals.
SignalForm	This is the form for creating and updating Signals.
SignalList	Like all OsidLists, SignalList provides a means for accessing Signal elements sequentially either one at a time or many at a time.
SignalLookupSession	This session defines methods for retrieving signals.
SignalMapAssignmentSession	This session provides methods to re-assign Signals to Map objects A Signal may appear in multiple Map objects and removing the last reference to a Signal is the equivalent of deleting it.
SignalMapSession	This session provides methods to retrieve Signal to Map signals.
SignalNotificationSession	This session defines methods to receive notifications on adds/changes to Signal objects in this Map.
SignalQuery	This is the query for searching signals.
SignalQueryInspector	This is the query inspector interface for examining signal queries.
SignalQuerySession	This session provides methods for searching among Signal objects.
SignalReceiver	The signal receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted signals.
SignalSearch	The search interface for governing signal searches.
SignalSearchOrder	An interface for specifying the ordering of search results.
SignalSearchResults	This interface provides a means to capture results of a search.
SignalSearchSession	This session provides methods for searching among Signal objects.
SignalSmartMapSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
SpeedZone	A SpeedZone represents a speed zone in a Map.
SpeedZoneAdminSession	This session creates, updates, and deletes SpeedZones.
SpeedZoneForm	This is the form for creating and updating SpeedZones.
SpeedZoneList	Like all OsidLists, SpeedZone provides a means for accessing SpeedZone elements sequentially either one at a time or many at a time.
SpeedZoneLookupSession	This session defines methods for retrieving speed zones.
SpeedZoneMapAssignmentSession	This session provides methods to re-assign SpeedZones to Map objects A SpeedZone may appear in multiple Map objects and removing the last reference to a SpeedZone is the equivalent of deleting it.
SpeedZoneMapSession	This session provides methods to retrieve SpeedZone to Map speed zones.
SpeedZoneNotificationSession	This session defines methods to receive notifications on adds/changes to SpeedZone objects in this Map.
SpeedZoneQuery	This is the query for searching speed zones.
SpeedZoneQueryInspector	This is the query inspector for examining speed zone queries.
SpeedZoneQuerySession	This session provides methods for searching among SpeedZone objects.
SpeedZoneReceiver	The speed zone receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted speed zones.
SpeedZoneSearch	The search interface for governing speed zone searches.
SpeedZoneSearchOrder	An interface for specifying the ordering of search results.
SpeedZoneSearchResults	This interface provides a means to capture results of a search.
SpeedZoneSearchSession	This session provides methods for searching among SpeedZone objects.
SpeedZoneSmartMapSession	This session manages queries and sequencing to create "smart" dynamic catalogs.

Package org.osid.mapping.path Description

The Open Service Interface Definitions for the org.osid.mapping.path service.

The Mapping Path OSID provides a means for managing spatial paths. This service may be used to link routing information with geospatial information or to simulate or monitor physical traffic.

Path

A Path is any interconnection that may represent a road, hallway, or orbit. A Path is plotted along a series of Coordinates to describe its geometry or may include data to generate the path from an equation.

A multi-lane road may be modeled as a series of individual paths along side each other. Each Path may have its own intersections, speed zones, obstacles, and signals.

Intersections

Intersections define a crossing of Paths where one can move from one Path to another. Different types of Intersections may exist including forks and rotaries.

Speed Zones

A SpeedZone specifies the speed limit between a set of Coordinates on a Path. SpeedZones may be manually created or automatically generated based on conditions along a Path.

Signals

A Signal represents some instruction to traffic along a Path. A Signal may be a traffic light, stop sign, or other control point in which to collect data about moving Resources.

Obstacles

Obstacles represent an obstruction that impacts the travel between a set of Coordinates along a Path. Obstacles may be used to generate implicit SpeedZones or completely block a Path.

Sub Packages

The Mapping Path OSID contains a Mapping Path Rules OSID for managing the effectiveness of SppedZones and Obstacles as well as a Mapping Path Batch OSID for managing Paths, Intersections, Signals, and Obstacles in bulk.

Copyright © 2010 Ingenescus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may modify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.