com.azalient.api.b.demand
Interface IPlace

All Superinterfaces:

IDescribed, IPlaces, IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

All Known Subinterfaces:

IArea, IZone

public interface IPlace
extends IPlaces, IDescribed, StoreRecordRW

An abstraction of an origin or destination object. A place may be an origin, or a destination, or both

Field Summary

static IPlace[]

ZERO A static zero-length array, created for convenience, and to save memory

Fields inherited from interface com.azalient.api.a.tables.IRecord

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

ITwig[]	arrivalTwigs() An array of the arrival twigs in this place -either links or walkways - where trips can finish
IXyz	centroid() Returns a location (which is initially the centre, but may have been moved).
double	constantVolume() A default constant (i.e.
ITwig[]	departureTwigs() An array of the departure twigs in this place -either links or walkways - where trips can start
double	height() The height of the prism
int	index() The 0..N-1 index of this object in its store
boolean	intersectsByHeight(IBezier curve) Return true if the curve is not completely below or completely above the prism
boolean	isCordon() Returns true if this place represents one on the edge of the network, part of the cordon around the model area
IXyz	label() The position of the label
String	name() The (integer) name of the zone, expressed as a String.
int	nameInt() The integer name of the zone, a unique ("external") integer ID.
PlaceType	placeType() Returns either AREA or ZONE
IList<IXyz>	points() A list of points making up the boundary of the base
IPolygon	polygon() A clockwise polygon representation of the boundary
boolean	selected()
int	vertices() The number of points in the boundary

Methods inherited from interface com.azalient.api.b.assignment.IPlaces

contains

Methods inherited from interface com.azalient.api.a.tables.IDescribed

description

Methods inherited from interface com.azalient.api.file.StoreRecordRW

canRename, rename, store

Methods inherited from interface com.azalient.api.file.RecordR

extraSet, finished, isApplicable, isEditable, set

Methods inherited from interface com.azalient.api.file.RecordW

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

Field Detail

ZERO

static final IPlace[] ZERO

A static zero-length array, created for convenience, and to save memory

Method Detail

nameInt

int nameInt()

The integer name of the zone, a unique ("external") integer ID. This must be unique across all zones.

index

int index()

The 0..N-1 index of this object in its store

name

String name()

The (integer) name of the zone, expressed as a String.

Specified by:

name in interface IPlaces

Specified by:

name in interface IRecord

placeType

PlaceType placeType()

Returns either AREA or ZONE

centroid

IXyz centroid()

Returns a location (which is initially the centre, but may have been moved). This location is used for a label to describe the place.

departureTwigs

ITwig[] departureTwigs()

An array of the departure twigs in this place -either links or walkways - where trips can start

arrivalTwigs

ITwig[] arrivalTwigs()

An array of the arrival twigs in this place -either links or walkways - where trips can finish

label

IXyz label()

The position of the label

vertices

int vertices()

The number of points in the boundary

points

IList<IXyz> points()

A list of points making up the boundary of the base

height

double height()

The height of the prism

polygon

IPolygon polygon()

A clockwise polygon representation of the boundary

intersectsByHeight

boolean intersectsByHeight(IBezier curve)

Return true if the curve is not completely below or completely above the prism

isCordon

boolean isCordon()

Returns true if this place represents one on the edge of the network, part of the cordon around the model area

selected

boolean selected()

constantVolume

double constantVolume()

A default constant (i.e. non-profiled) volume, used to generate trips in the absence of other demand