|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IParameters
A handle to the data associated with the Parameters component. This gives API access to all the objects that can be edited using windows on the main Parameters menu
| Field Summary | |
|---|---|
static int |
STD_DATE
The standard simulation date |
static UTime |
STD_FINISH
The standard simulation finish time, 09:00 |
static UTime |
STD_START
The standard simulation start time, 08:00 |
static double |
STD_STEP
The standard simulation time interval |
| Fields inherited from interface com.azalient.api.a.tables.IModule |
|---|
NONE |
| Fields inherited from interface com.azalient.api.a.tables.IPage |
|---|
ZERO |
| Method Summary | |
|---|---|
TableRW[] |
allTables()
Return all tables in this page |
IType[] |
allTypesSuitableForMode(TripMode mode)
Return an array of types suitable for a given trip mode |
IStore<IBehaviour> |
behaviours()
A store of Behaviours |
IStore<ICrossingTime> |
crossingTimes()
A store of crossing times, used to control walk, dont-walk and cycle times for pedestrian crossings |
boolean |
cyclesExist()
Return true if cycles exist in this model |
int |
date()
The date of the current simulation run, expressed as an integer, for example 20160625 is 25th June, 2016 |
IBehaviour |
defaultBehaviour()
A handle to the default behaviour, with all parameters at default settings. |
IPersonType |
defaultPersonType()
A handle to the default person type |
ITransportType |
defaultTransportType()
A handle to the default transport type |
IVehicleType |
defaultVehicleType()
A handle to the default vehicle type |
IStore<IDivision> |
divisions()
A store of demand divisions |
IList<IDivision> |
divisions(TripMode[] modes)
A list of divisions appropriate for a given mode - this is used for example, in parking, to extract all private vehicle divisions |
boolean |
driveOnRight()
Return true if the model is set up for vehicles to drive on the right hand side of the road |
boolean |
emergenciesExist()
Return true if emergency vehicles exist in the model |
IStore<IEngine> |
engines()
A store of engine definitions |
IStore<IFleet> |
fleets()
A store of fleets - a fleet is a set of vehicle types |
boolean |
importe()
Import parameters from another model |
IMob |
mobEquivalent(ITypeSet division)
This generates an equivalent mob for a division or fleet. |
IStore<IMob> |
mobs()
A store of Mobs (Mixture Of Behaviours) |
IMotorCalibration |
motorCalibration()
A handle to vehicle (motorised agent) calibration parameters |
IMotorFollowing |
motorFollowing(IMotorCalibration.FollowingModel model)
A handle to the car following model parameters |
ICompoundStore<IMotorType> |
motorTypes()
A compound store of all motorised types, that is VehicleTypes and TransportTypes |
IPedestrianCalibration |
pedestrianCalibration()
A handle to pedestrian calibration parameters |
IStore<IPersonType> |
personTypes()
A store of person types (People Window) |
IRestriction |
restriction(int index)
Lookup a restriction by index |
IRestriction |
restriction(String name)
Lookup a restriction by name |
IStore<IRestriction> |
restrictions()
A store of restrictions |
IList<IRestriction> |
restrictions(SurfaceMode mode)
A list of restrictions suitable for a given mode |
ITerm |
simulationTerm()
The simulation term, controlling when the simulation starts and when it finishes |
IStore<ISpeedControl> |
speedcontrols()
A store of speed control objects, used to apply time-variable lane-specific speed controls |
boolean |
taxisExist()
Return true if taxis exist in this model |
IStore<ITerm> |
terms()
A store of Terms |
IStore<IDistribution> |
timeDiscretes()
A store of discrete time distributions, specified by p% at time T, q% at time U, etc |
IStore<IDistributionBar> |
timeDistributionBars()
A store of bars used within time distributions |
ICompoundStore<IDistribution> |
timeDistributions()
A compound store of all time distributions, discrete and continuous |
IStore<IDistribution> |
timeGaussians()
A store of continuous Gaussian time distribution objects, specified by mean and standard deviation |
double |
timeStep()
The simulation time step or interval, in seconds |
IStore<ITransportType> |
transportTypes()
A store of public transport vehicle types (menu Network / Services /Transport Types) |
ICompoundStore<IType> |
types()
A compound store of all types, that is, person, vehicle and transport types |
IStore<IVehicleType> |
vehicleTypes()
A store of vehicle types (Vehicles Window) |
| Methods inherited from interface com.azalient.api.a.tables.IModule |
|---|
addTable, baseName, childModules, destroy, open, open, pageName, pageType, parentModule, rename, save, save, table, verify |
| Methods inherited from interface com.azalient.api.a.tables.IPage |
|---|
baseName, pageName, pageType |
| Field Detail |
|---|
static final UTime STD_START
static final UTime STD_FINISH
static final int STD_DATE
static final double STD_STEP
| Method Detail |
|---|
IStore<ITerm> terms()
IStore<IBehaviour> behaviours()
IStore<IMob> mobs()
IMob mobEquivalent(ITypeSet division)
IStore<IPersonType> personTypes()
IStore<IVehicleType> vehicleTypes()
IStore<ITransportType> transportTypes()
ICompoundStore<IMotorType> motorTypes()
ICompoundStore<IType> types()
IType[] allTypesSuitableForMode(TripMode mode)
IStore<IDivision> divisions()
IStore<IFleet> fleets()
IList<IDivision> divisions(TripMode[] modes)
IStore<IRestriction> restrictions()
IList<IRestriction> restrictions(SurfaceMode mode)
IRestriction restriction(String name)
IRestriction restriction(int index)
IStore<ISpeedControl> speedcontrols()
IStore<IDistributionBar> timeDistributionBars()
IStore<IDistribution> timeDiscretes()
IStore<IDistribution> timeGaussians()
ICompoundStore<IDistribution> timeDistributions()
IStore<ICrossingTime> crossingTimes()
IStore<IEngine> engines()
TableRW[] allTables()
ITerm simulationTerm()
IPedestrianCalibration pedestrianCalibration()
IMotorCalibration motorCalibration()
IMotorFollowing motorFollowing(IMotorCalibration.FollowingModel model)
double timeStep()
int date()
boolean driveOnRight()
boolean taxisExist()
boolean cyclesExist()
boolean emergenciesExist()
IBehaviour defaultBehaviour()
IPersonType defaultPersonType()
ITransportType defaultTransportType()
IVehicleType defaultVehicleType()
boolean importe()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||