Expression Keywords

Contents - Index - Previous - Next

Expression Keywords

An expression consists of operators, functions and keywords.

Valid keywords depend on the type of network element, and are listed below. Most of these keywords correspond to ones used in EMME/2 network calculations and in ENIF configurations.

Generic Keywords
IsCompare : Returns TRUE if the comparison element exists in the comparison scenario
HasAutoAssignment : Returns TRUE if the scenario has auto assignment results
HasTransitAssignment : Returns TRUE if the scenario has transit assignment results
IsModifyProtect : Returns TRUE if the scenario is protected against modification

Centroid Keywords
ind, index : The index of the centroid in the EMME/2 database
i, inode : The centroid number
x, xi, y, yi : The x or y coordinate of the centroid
ui1, ui2, ui3 : The value of the centroid user attributes
label, lbi : The centroid label (if any)
@xxxx : Extra attribute value
ms1, ms2... : The value of scalar matrix ms1 (or ms2, ms3 etc.)
mo1, mo2... : The value of origin matrix mo1 (or mo2, mo3 etc.) for the centroid
md1, md2... : The value of destination matrix md1 (or md2, md3 etc.) for the centroid
ga(i), gb(i)... : The value of ensemble ga (or gb, gc etc.) for the centroid
Compare->xxx : Points to a centroid attribute in the comparison scenario. (for example, Compare->ui1)

Node Keywords
ind, index : The index of the node in the EMME/2 database
i, inode : The node number
x, xi, y, yi : The x or y coordinate of the node
ui1, ui2, ui3 : The value of the node user attributes
@xxxx : Extra attribute value
fiali, fialii : The final transit alightings at the node
inboa, inboaii : The initial transit boardings at the node
label, lbi : The node label (if any)
IsIntersection : Returns TRUE if the node is an intersection
Compare->xxx : Points to a node attribute in the comparison scenario. (for example, Compare->inboa)

Link Keywords
i, inode : The number of the I-Node
j, jnode : The number of the J-Node
xi, yi : The x and y coordinates of the I-node
xj, yj : The x and y coordinates of the J-node
ul1, ul2, ul3 : The value of the user attributes of the link
ul1r, ul2r, ul3r : The value of the user attributes of the reverse link
length, len : The length of the link
lengthr, lenr : The length of the reverse link
@xxxx : Extra attribute value
speedau : Auto speed on the link
speedaur : Auto speed on the reverse link
lan, lanes : The number of lanes on the link
lanr, lanesr : The number of lanes on the reverse link
mode, modes : The modes on the link
moder, modesr : The modes on the reverse link
vdf : The volume-delay function on the link
vdfr : The volume-delay function on the reverse link
typ, type : The link type
typr, typer : The type of the reverse link
timau : The auto time on the link
timaur : The auto time on the reverse link
speedau : Auto speed on the link (a function of the auto time and link length)
speedaur : Auto speed on the reverse link
volau : The assigned auto volume on the link
volaur : The assigned auto volume on the reverse link
volad : The additional auto volume on the link
voladr : The additional auto volume on the reverse link
volax : The auxiliary transit volume on the link
volaxr : The auxiliary transit volume on the reverse link
angle : The angle of the link (in degrees * 10)
angler : The angle of the reverse link (in degrees * 10)
IsConnector : Returns TRUE if the link is a connector
IsAccess : Returns TRUE if the link is an access connector
IsEgress : Returns TRUE if the link is an egress connector
IsAuto : Returns TRUE if the auto mode is defined on the link
IsTransit : Returns TRUE if the link has a transit mode on the link
IsAuxAuto : Returns TRUE if an auxiliary auto mode is defined on the link
IsAuxTransit : Returns TRUE if an auxiliary transit mode is defined on the link
IsOneWay : Returns TRUE if the link does not have a reverse link
IsCurved : Returns TRUE if the link has curve information.
Compare->xxx : Points to a link attribute in the comparison scenario. (for example, Compare->volau)

Transit Line and Segment Keywords
ind, index, lindex : The transit line index
line, lname : The transit line name
description, ldesc : The transit line description
linemode : The transit line mode
mdesc : The transit line mode description
veh, vehicle : The transit line vehicle type
vauteq : Auto equivalent of vehicle type
vdesc : The transit line vehicle description
hdw, hdwy : The transit line headway
lay1, layover1 : First layover (in minutes)
lay2, layover2 : Second layover (in minutes)
nseg1 : Number of segments before the first layover
nsegt : Total number of segments in the line
ut1, ut2, ut3 : Transit line user attributes
capt : The total capacity of the line (persons per hour)
vcapt : The total capacity of the vehicle on the line (persons per vehicle)
caps : The seated capacity of the line (persons per hour)
vcaps : The seated capacity of the vehicle on the line (persons per vehicle)
vcohr : Cost/hour coefficient of the vehicle on the line
vcolu : Cost/distance coefficient of the vehicle on the line
venhr : Energy/hour coefficient of the vehicle on the line
venlu : Energy/distance coefficient of the vehicle on the line
vfleet : Fleet size of the vehicle type
@xxxx : Extra attribute value
i : I-Node of segment
j : J-node of segment
dwt : Dwell time at I-Node of the segment (in minutes)
dwtn : Dwell time at J-Node of the segment (in minutes)
dwfac : Dwell time factor at I-Node of the segment
dwfacn : Dwell time factor at J-Node of the segment
noali : No-alighting indicator at I-Node of the segment
noalin : No-alighting indicator at I-Node of the segment
noboa : No-boarding indicator at I-Node of the segment
noboan : No-boarding indicator at I-Node of the segment
ttf : Transit time function index
ttfn : Transit time function index of the next segment
ttft : Transit time function index on turn
ttfn : Transit time function index on turn for the next segment
us1, us2, us3 : Transit segment user data
us1n, us2n, us3n : User data for the next segment
segno : Sequential segment number in the transit line
segnon : Sequential segment number of the next segment in the transit line
isFirst : Returns TRUE if this is the first segment in the line
isMidLayover : Returns TRUE if the segment is the mid-layover of the line
isLast : Returns TRUE if this is the lasat segment in the line
isIBoardingStop : Returns TRUE if boarding is allowed at the I-Node of the segment
isIAlightingStop : Returns TRUE if alighting is allowed at the I-Node of the segment
isIStop : Returns TRUE if boarding and/or alighting is allowed at the I-Node of the segment
isJBoardingStop : Returns TRUE if boarding is allowed at the J-Node of the segment
isJAlightingStop : Returns TRUE if alighting is allowed at the J-Node of the segment
isJStop : Returns TRUE if boarding and/or alighting is allowed at the J-Node of the segment
board : The number of boardings at the I-Node of the segment
boardn : The number of boardings at the J-Node of the segment
timtr : The transit time on the segment
timtrn : The transit time on the next segment
voltr : The transit volume on the segment
voltrn : The transit volume on the next segment
Compare->xxx : Points to a line or segment attribute in the comparison scenario. (for example, Compare->board)

In addition to the line and segment specific keywords, all link keywords also apply. For example, the keyword volad will return the additional auto volume on the segment.

Turn Keywords
angle : The angle of the incoming link (in degrees * 10)
i : The at-node of the turn
j : The from-node of the turn
k : The to-node of the turn
tpf : The turn penalty function index
pvolau : Auto volumes on turns
pvolad : Additional turn volumes
ptimau : Auto times on turns
up1, up2, up3 : Turn user data

In addition to these keywords, all node and link keywords also apply.

Regular link keywords can be used to determine values for the incoming link. Values for the outgoing link are obtained by adding the letter "m" to the keyword. For example, the keyword volau will return the auto volume on the incoming link while the keyword volaum will return the auto volume on the outgoing link.

The I-node of the incoming link is referenced with the letter "i", the J-node of the incoming link is referenced with the letter "j", and the letter "k" references the J-node of the outgoing link. For example, the keyword inboai will return the initial boardings at the I-node of the incoming turn, inboaj will return the initial boardings at the J-node of the incoming, and inboak will return the initial boardings at the J-node of the outgoing link.

Matrix Keywords
mv : The matrix value
p : The origin zone (centroid) number
q : The destination zone (centroid) number
ga(q), gb(q)... : The value of ensemble ga (or gb, gc etc.) for the origin zone
ga(p), gb(p)... : The value of ensemble ga (or gb, gc etc.) for the destination zone
msnn : The value of scalar matrix msnn where nn is the matrix number.
monn : The value of origin matrix monn where nn is the matrix number.
mdnn : The value of destination matrix mdnn where nn is the matrix number.
mfnn : The value of full matrix mfnn where nn is the matrix number.

Pointer Keywords
In addition to the above keywords, with M2Assistant you can 'point to' or reference a network element that is related to the current network element. For example, you can reference attributes of the I-node or J-node of a link, or vehicle attributes of a transit line, or link attributes for a turn. You may also reference the comparison scenario by using the Compare pointer keyword.

The pointer keywords,

Compare->xxx : Points to an attribute in the comparison scenario. eg. Compare->volau
Pi-> : Points to the I-node of a link or segment, or the I-node of the incoming link of a turn. eg. Pi->x
Pj-> : Points to the J-node of a link or segment, or the J-node of the incoming link of a turn. eg. Pj->y
Pk-> : Points to the J-node of the outgoing link of a turn. eg. Pk->y
Pij-> : Points to the corresponding link of a segment, or the incoming link of a turn. eg. Pij->volau
Pjk-> : Points to the outgoing link of a turn. eg. Pjk->volau
Pnext-> : Points to the next segment in the transit line. eg. Pnext->voltr
Pprev-> : Points to the previous segment in the transit line. eg. Pprev->voltr
Pline-> : Points to the corresponding transit line. eg. Pline->description
Pveh-> : Points to the corresponding transit vehicle. eg. Pveh->vcaps

Note that a special keyword is used to determine if the same element is available in the comparison scenario. The keyword isCompare will return TRUE if the same link (or node) exists exist in the comparison scenario. A filter using this keyword could be

((iscompare) and (compare->volau) > 1000)