GKTrafficStateItem Class Reference

Public Member Functions
	GKTrafficStateItem ()
bool	usesSection (GKSection *section) const
float	getEntranceFlow () const
void	setEntranceFlow (float value)
float	getKeepFlowPercentage () const
void	setKeepFlowPercentage (float value)
float	getTurningPercentage (GKSection *toSection) const
void	setTurningPercentage (GKSection *toSection, float value)
float	getTotalTurningPercentage () const
float	getExitFlow (GKSection *toSection) const
void	setExitFlow (GKSection *toSection, float value)
float	getTotalExitFlow () const

Detailed Description

This class holds the traffic state of a section. It is composed of:

• entrance flow: number of vehicles that enters in a section during the period specified in the GKTrafficState
• keep flow percentage: percentage of vehicles that exits the network in this section
• turn percentage: percentage of vehicles that takes a turn, defined by the destination section.
• exit flow: number of vehicles that exit a section from each of its turns.

Constructor & Destructor Documentation

GKTrafficStateItem()

GKTrafficStateItem::GKTrafficStateItem

(

)

Member Function Documentation

getEntranceFlow()

float GKTrafficStateItem::getEntranceFlow

(

)

const

Returns the entrance flow on this section. Note that -1 is returned if undefined.

getExitFlow()

float GKTrafficStateItem::getExitFlow

(

GKSection *

toSection

)

const

Returns the exit flow using turn to section "toSection". Note that -1 is returned if undefined.

getKeepFlowPercentage()

float GKTrafficStateItem::getKeepFlowPercentage

(

)

const

Returns the percentage of vehicles that exits the network in this section. Note that -1 is returned if undefined.

getTotalExitFlow()

float GKTrafficStateItem::getTotalExitFlow

(

)

const

Returns the total exit flow. Note that -1 is returned if there is not any exit flow defined.

getTotalTurningPercentage()

float GKTrafficStateItem::getTotalTurningPercentage

(

)

const

Returns the total percentage assigned to exits. It must be 100.0, anything else is an error. Note that -1 is returned if undefined

getTurningPercentage()

float GKTrafficStateItem::getTurningPercentage

(

GKSection *

toSection

)

const

Returns the percentage of vehicles that takes a turn to section "toSection".

setEntranceFlow()

void GKTrafficStateItem::setEntranceFlow

(

float

value

)

Sets the entrance flow on this section.

setExitFlow()

void GKTrafficStateItem::setExitFlow	(	GKSection *	toSection,
		float	value
	)

Sets the exit flow using turn to section "toSection".

setKeepFlowPercentage()

void GKTrafficStateItem::setKeepFlowPercentage

(

float

value

)

Sets the percentage of vehicles that exits the network in this section.

setTurningPercentage()

void GKTrafficStateItem::setTurningPercentage	(	GKSection *	toSection,
		float	value
	)

Sets the percentage of vehicles that takes a turn to section "toSection".

usesSection()

bool GKTrafficStateItem::usesSection

(

GKSection *

section

)

const

Is this section used in the item?