com.visioglobe.libVisioDevKit
Class VgIRoutingModule

java.lang.Object
  com.visioglobe.libVisioDevKit.VgIModule
      com.visioglobe.libVisioDevKit.VgIRoutingModule

public class VgIRoutingModule
extends VgIModule

VgIRoutingModule provides access to routing related objects

Field Summary

Fields inherited from class com.visioglobe.libVisioDevKit.VgIModule

swigCMemOwn

Constructor Summary

VgIRoutingModule(long cPtr, boolean cMemoryOwn)

Method Summary

void	delete()
protected void	finalize()
void	getAllAttributeNames(VgStringVector pNames) This method is used to get the names of all the attributes present in the database.
void	getAllModalityNames(VgStringVector pNames) This method is used to get the names of all the modalities present in the database.
static long	getCPtr(VgIRoutingModule obj)
VgIRouteConverterFactory	getRouteConverterFactory() Retrieves the route converter factor.
VgIRoutingSolver	getRoutingSolver() Retrieves the routing solver.
int	setEdgeTimeByAttributeAndModality(java.lang.String pEdgeAttribute, java.lang.String pModality, float pTime) This method is used to set the traversal time for a given modality on.

Methods inherited from class com.visioglobe.libVisioDevKit.VgIModule

getCPtr, getName

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VgIRoutingModule

public VgIRoutingModule(long cPtr,
                        boolean cMemoryOwn)

Method Detail

getCPtr

public static long getCPtr(VgIRoutingModule obj)

finalize

protected void finalize()

Overrides:

finalize in class VgIModule

delete

public void delete()

Overrides:

delete in class VgIModule

getRoutingSolver

public VgIRoutingSolver getRoutingSolver()

Retrieves the routing solver.

Returns:

VgIRoutingSolver if valid, otherwise NULL.

getRouteConverterFactory

public VgIRouteConverterFactory getRouteConverterFactory()

Retrieves the route converter factor.

setEdgeTimeByAttributeAndModality

public int setEdgeTimeByAttributeAndModality(java.lang.String pEdgeAttribute,
                                             java.lang.String pModality,
                                             float pTime)

This method is used to set the traversal time for a given modality on. edges with a given attribute. It returns the number of affected edges.

Parameters:

pEdgeAttribute - The searched attributes. All edges with that attribute will be affected.

pModality - The affected modality (time can only be set for modalities, no time concept in edges alone).

pTime - The time to associate.

Returns:

The number of edges that were affected.

Remark:

the change to the edge's time is not persistent across loadConfigurations. It must be done every time the configuration is loaded.

getAllModalityNames

public void getAllModalityNames(VgStringVector pNames)

This method is used to get the names of all the modalities present in the database. It can return an empty vector if no modalities are specified within the database.

Parameters:

pNames - The list of strings that will be fed with the modality names.

getAllAttributeNames

public void getAllAttributeNames(VgStringVector pNames)

This method is used to get the names of all the attributes present in the database. It can return an empty vector if no modalities are specified within the database.

Parameters:

pNames - The list of strings that will be fed with the attribute names.