com.kuka.nav.path
Interface VirtualPathData

public interface VirtualPathData

Access methods for virtual path data source.

Method Summary

VirtualPath	get(int pathId) Returns the virtual path with the given id in the data source.
VirtualPath	get(int mapId, String pathName) Returns the virtual path with the given name associated to the map with the given id in the data source.
VirtualPath	get(String mapName, String pathName) Returns the virtual path with the given name associated to the map with the given name in the data source.
Collection<VirtualPath>	getAll() Returns a list containing all virtual paths in the data source.
Collection<VirtualPath>	getAllOnMap(int mapId) Returns a list containing all virtual paths in the data source located on the map with the given id.
Collection<VirtualPath>	getAllOnMap(String mapName) Returns a list containing all virtual paths in the data source located on the map with the given name.

Method Detail

getAll

Collection<VirtualPath> getAll()

Returns a list containing all virtual paths in the data source. If no virtual paths are defined an empty list is returned.

Returns:

a list containing all virtual paths in the data source.

getAllOnMap

Collection<VirtualPath> getAllOnMap(int mapId)

Returns a list containing all virtual paths in the data source located on the map with the given id. If no virtual paths are defined on the corresponding map an empty list is returned.

Parameters:

mapId - the id of the map for which the virtual paths are to be returned

Returns:

a list containing all virtual paths in the data source located on the map with the given id

getAllOnMap

Collection<VirtualPath> getAllOnMap(String mapName)

Returns a list containing all virtual paths in the data source located on the map with the given name. If no virtual paths are defined on the corresponding map an empty list is returned.

Parameters:

mapName - the name of the map for which the virtual paths are to be returned

Returns:

a list containing all virtual paths in the data source located on the map with the given name

get

VirtualPath get(int pathId)

Returns the virtual path with the given id in the data source. If the virtual path does not exist null is returned.

Parameters:

pathId - the id of the virtual path to be returned

Returns:

the virtual path with the given id or null if it does not exist

get

VirtualPath get(int mapId,
                String pathName)

Returns the virtual path with the given name associated to the map with the given id in the data source. If the virtual path does not exist null is returned.

Parameters:

mapId - the id of the associated map

pathName - the name of the virtual path to be returned

Returns:

the virtual path with the given name or null if it does not exist

get

VirtualPath get(String mapName,
                String pathName)

Returns the virtual path with the given name associated to the map with the given name in the data source. If the virtual path does not exist null is returned.

Parameters:

mapName - the name of the associated map

pathName - the name of the virtual path to be returned

Returns:

the virtual path with the given name or null if it does not exist