com.azalient.api.b.network
Interface ISector

All Superinterfaces:

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

public interface ISector
extends IPlaces, StoreRecordRW

A sector is a collection of Places (Zones or Areas). A sector is used to group origins or destinations, to make it easier to create rules that test if an agent is connected with one of the origins or destinations.

Field Summary

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

void	add(IPlace place) Add the given place to the collection
NamedColour	colour() The colour associated with this sector
boolean	contains(ISector that) Returns true if this sector contains all the places in that sector
boolean	isZones() Returns true if this sector contains only zones.
boolean	parkingEquivalence() Returns true if all (parking) zones in this sector are equivalent in terms of parking.
IList<IPlace>	places() A list of places in this sector
void	remove(IPlace place) Remove the given place from the collection
void	sort() Sort the place in the sector into numeric-index order.

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

contains, name

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.a.tables.IRecord

name

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

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

Method Detail

colour

NamedColour colour()

The colour associated with this sector

places

IList<IPlace> places()

A list of places in this sector

contains

boolean contains(ISector that)

Returns true if this sector contains all the places in that sector

add

void add(IPlace place)

Add the given place to the collection

remove

void remove(IPlace place)

Remove the given place from the collection

parkingEquivalence

boolean parkingEquivalence()

Returns true if all (parking) zones in this sector are equivalent in terms of parking. That is, when searching for possible routes that include a driving section, if zone A is parking-equivalent to zone B, then a driving trip will NOT be considered between A and B

sort

void sort()

Sort the place in the sector into numeric-index order. All places have a unique numeric index

isZones

boolean isZones()

Returns true if this sector contains only zones.