Package org.goplanit.tntp

Class TntpMain

java.lang.Object

org.goplanit.tntp.TntpMain

public class TntpMain
extends Object

Main class for running TNTP models

Author:

gman6028

Field Summary

Fields

Modifier and Type	Field	Description
static double	DEFAULT_CONVERGENCE_EPSILON
static int	DEFAULT_MAX_ITERATIONS
static double	DEFAULT_MAXIMUM_SPEED

Constructor Summary

Constructors

Constructor	Description
TntpMain()

Method Summary

Modifier and Type	Method	Description
void	execute(String networkFileLocation, String demandFileLocation, String nodeCoordinateFileLocation, String linkOutputFilename, String odOutputFilename, String odPathOutputFilename, boolean persistZeroFlow, int maxIterations, double epsilon, Unit outputCostTimeUnit, double defaultMaximumSpeed)	Top-level method which runs PLANit for TNTP format input
static void	main(String[] args)	Top-level class for running TNTP models

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_ITERATIONS

public static final int DEFAULT_MAX_ITERATIONS

See Also:

Constant Field Values

DEFAULT_CONVERGENCE_EPSILON

public static final double DEFAULT_CONVERGENCE_EPSILON

See Also:

Constant Field Values

DEFAULT_MAXIMUM_SPEED

public static final double DEFAULT_MAXIMUM_SPEED

See Also:

Constant Field Values

Constructor Detail

TntpMain

public TntpMain()

Method Detail

main

public static void main(String[] args)

Top-level class for running TNTP models

Parameters:

args - Command-line arguments for TNTP model

execute

public void execute(String networkFileLocation,
                    String demandFileLocation,
                    String nodeCoordinateFileLocation,
                    String linkOutputFilename,
                    String odOutputFilename,
                    String odPathOutputFilename,
                    boolean persistZeroFlow,
                    int maxIterations,
                    double epsilon,
                    Unit outputCostTimeUnit,
                    double defaultMaximumSpeed)
             throws PlanItException

Top-level method which runs PLANit for TNTP format input

Parameters:

networkFileLocation - the input network file (required)

demandFileLocation - the input trips file (required)

nodeCoordinateFileLocation - the node coordinate file (null if not included)

linkOutputFilename - the link output CSV file

odOutputFilename - the OD output CSV file

odPathOutputFilename - the OD path output CSV file

persistZeroFlow - if true record

maxIterations - the maximum number of iterations

epsilon - the epsilon used for convergence

outputCostTimeUnit - the output time units

defaultMaximumSpeed - the default maximum speed along links

Throws:

PlanItException - thrown if there is an error