Link (segment) Output Property Support

Output properties that can be activated for the output type: Link (segment).

Some output properties are not only contingent on the output type but on the combination of output type and PLANit traffic assignment component, such as, for example, the type of traffic assignment. For those specialised output properties, we direct the reader to the appropriate page of the PLANit component where these properties are listed.

We list the supported output properties for link (segment) ordered by their priority (id, input, output).

The Output property column lists the enum that is used to uniquely identify the property, whether it be in Java or Python.

ID_PRIORITY

Output Property	Description	Type	Unit
DOWNSTREAM_NODE_ID	Link segment’s downstream node id (internal)	long	None
DOWNSTREAM_NODE_XML_ID	Link segment’s downstream node XML id (input)	string	None
DOWNSTREAM_NODE_EXTERNAL_ID	Link segment’s downstream node external id (input)	string	None
ITERATION_INDEX	Iteration index of simulation	integer	None
LINK_SEGMENT_ID	Link segment id (internal)	long	None
LINK_SEGMENT_XML_ID	Link segment XML id (input)	string	None
LINK_SEGMENT_EXTERNAL_ID	Link segment external id (input)	string	None
MODE_ID	Mode id (internal)	long	None
MODE_XML_ID	Mode XML id (input)	string	None
MODE_EXTERNAL_ID	Mode external id (input)	string	None
RUN_ID	simulation run id	long	None
TIME_PERIOD_ID	time period id (internal)	long	None
TIME_PERIOD_XML_ID	time period XML id (input)	string	None
TIME_PERIOD_EXTERNAL_ID	time period external id (input)	string	None
UPSTREAM_NODE_ID	Link segment’s upstream node id (internal)	long	None
UPSTREAM_NODE_XML_ID	Link segment’s upstream XML node id (user)	string	None
UPSTREAM_NODE_EXTERNAL_ID	Link segment’s upstream external node id (user)	string	None

INPUT_PRIORITY Fields

Output Property	Description	Type	Unit
CAPACITY_PER_LANE	The capacity flow rate for a lane	float	pcu/h(/l)
DOWNSTREAM_NODE_LOCATION	The geographic location of the downstream node (if present)	string	SRS
LENGTH	The length	float	km
LINK_TYPE	The link segment type’s name (input)	string	None
MAXIMUM_DENSITY	The maximum density allowed on the link segment	float	pcu/km
MAXIMUM_SPEED	The maximum allowed speed	float	km/h
NUMBER_OF_LANES	The number of lanes	integer	None
UPSTREAM_NODE_LOCATION	The geographic location of the upstream node (if present)	string	SRS

OUTPUT_PRIORITY Fields

Output Property	Description	Type	Unit
CALCULATED_SPEED	The calculate speed	float	km/h
COST_TIMES_FLOW	The cost (per pcu) multiplied with the volume (per hour) on the entity	float	h (i.e., (h/pcu)*(pcu/1))
DENSITY	The density on the link segment	float	pcu/km
INFLOW	The inflow rate	float	pcu/h
FLOW	The flow rate	float	pcu/h
LINK_SEGMENT_COST	The link segment’s generalised cost	float	h
OUTFLOW	The inflow rate	float	pcu/h
VC_RATIO	The volume to capacity ratio	float	None ((pcu/h)/(pcu/h))