GKRoadType Class Reference

Inheritance diagram for GKRoadType:

Public Types
enum	DrawMode {   eRoad = 0 , eRailway = 1 , eTramtrack = 2 , eNotDrawn = 3 ,   eTrafficLightsOnly = 4 }
enum	HCMRoadType { eNone = 0 , eFreeway , eMultilaneHw , eUrban }
Public Types inherited from GKObject
enum	IdentifierFormFlag {   eIdentifierDefault , eIdentifierId , eIdentifierName , eIdentifierExternalId ,   eIdentifierTypeExternalName , eIdentifierDescription , eIdentifierStandard , eIdentifierStandardWithType ,   eIdentifierAll }
enum	GKLockType { eNone , eModification , eDelete , eModificationDelete }
enum	GKObjectStatus { eNew , eSaved , eModified , eDeleted }
typedef QFlags< GKObject::IdentifierFormFlag >	IdentifierForm

Public Member Functions
	GKRoadType ()
void	setAsDefault ()
void	unSetAsDefault ()
bool	isDefault () const
bool	isInternal () const
unsigned char	getFunctionalClass () const
void	setFunctionalClass (unsigned char value)
DrawMode	getDrawMode () const
void	setDrawMode (DrawMode value)
QVector< const GKMobileAgent * >	getNonAllowedVehicles () const
void	setNonAllowedVehicles (QVector< const GKMobileAgent * > vehicles)
int	getNumberOfSectionsUsingRoadType () const
void	updateSectionsInRoadType ()
Public Member Functions inherited from GKObject
	GKObject ()
	GKObject (const GKObject &o)
virtual void	addedToCatalog ()
virtual void	removedFromCatalog ()
uint	getTick () const
virtual void	increaseTick ()
void	setTick (uint t)
virtual GKObject *	clone (bool addItToModel=true) const
virtual GKObject *	cloneAsTemporary (bool addItToModel=true) const
GKFolder *	getCreateRootFolder ()
GKFolder *	getRootFolder () const
void	setRootFolder (GKFolder *afolder)
GKFolder *	findFolder (const QString &byName) const
QVector< GKFolder * >	getParentFolders () const
bool	isDataValueNull (const GKColumn *attr) const
virtual QVariant *	getDataValue (const GKColumn *attr, bool *deleteit, const GKContext &context=GKContext::anyContext) const
QVariant *	getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const
virtual void	setDataValue (const GKColumn *attr, const QVariant &v)
void	setDataValueByID (uint attrId, const QVariant &v)
virtual void	setDataValueObject (const GKColumn *attr, const GKObject *obj)
void	setDataValueObjectByID (uint attrId, const GKObject *obj)
virtual void	setDataValueDouble (const GKColumn *attr, double v)
void	setDataValueDoubleByID (uint attrId, double v)
virtual double	getDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double *deviation=NULL) const
double	getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const
bool	hasAnyTSWithData () const
virtual GKTimeSerie *	getDataValueTS (const GKColumn *attr) const
GKTimeSerie *	getDataValueTSByID (uint attrId) const
virtual void	setDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription=NULL, int reservedSize=0)
virtual void	setDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, double lowerValue, GKTSDescription *aDescription=NULL, int reservedSize=0)
virtual void	setDataValueInSingleTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription)
void	setDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription=NULL, int reservedSize=0)
virtual void	setAggregatedValueInTS (const GKColumn *attr, double value, double deviation, GKTSDescription *aDescription=NULL)
void	setAggregatedValueInTSByID (uint attrId, double value, double deviation, GKTSDescription *aDescription=NULL)
virtual void	clearDataValueTS (const GKColumn *attr, GKTSDescription *aDescription=NULL)
void	clearDataValueTSByID (uint attrId, GKTSDescription *aDescription=NULL)
virtual int	getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
int	getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const
virtual double	getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
double	getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const
QString	getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
QString	getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const
virtual bool	getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
bool	getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const
virtual GKObject *	getDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
GKObject *	getDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const
QDate	getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
QDate	getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const
QTime	getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
QTime	getDataValueTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const
QDateTime	getDataValueDateTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
QDateTime	getDataValueDateTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const
GKTimeDuration	getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
GKTimeDuration	getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const
void	removeDataValue (const GKColumn *attr)
void	removeDataValueByID (uint attrId)
const QString &	getDescription () const
void	setDescription (const QString &adescription)
const QString &	getExternalId () const
void	setExternalId (const QString &anId)
virtual GKObjectDelCmd *	getDelCmd ()
virtual GKObjectConnectionDelCmd *	getDelConnectionCmd (GKObject *target)
virtual void	nonCommandObjectRemoved (GKObject *)
virtual void	init ()
virtual void	setId (uint aid, GKModel *model)
uint	getId () const
QUuid	getUUID () const
virtual void	setName (const QString &aname)
const QString &	getName () const
QString	getExtendedId (IdentifierForm form=eIdentifierDefault) const
QString	getNameOrExtendedId (IdentifierForm form=eIdentifierDefault) const
virtual const QString &	getTypeName () const
virtual QString	getTypeExternalName () const
const GKObject *	getMaster () const
GKType *	getType () const
virtual void	setType (GKType *atype)
bool	isA (const GKType *atype) const
bool	isA (const QString &typeName) const
virtual void	setModel (GKModel *amodel)
GKModel *	getModel () const
virtual void	setLock (GKLockType atype)
GKLockType	getLock () const
virtual bool	canBeDeleted () const
virtual bool	canBeModified () const
virtual bool	canBeEdited () const
GKObjectStatus	getStatus () const
virtual void	setStatus (const GKObjectStatus astatus)
void	notifyStatusChange ()
bool	isTemporary () const
void	setTemporary (bool value)
bool	isExternal () const
void	setExternal (bool value)
virtual void	preferencesChanged ()
void	removeColumn (GKColumn *column)
void	resetColumn (GKColumn *column)
Public Member Functions inherited from GKBaseObject
	GKBaseObject ()
	if (base)
virtual uint	getId () const =0
virtual const QString &	getTypeName () const =0
virtual QString	getTypeExternalName () const =0
virtual const GKObject *	getMaster () const =0
virtual const QString &	getName () const =0
virtual const QString &	getExternalId () const =0
virtual const QString &	getDescription () const =0
virtual GKModel *	getModel () const =0
virtual QVariant *	getDataValue (const GKColumn *attr, bool *deleteit, const GKContext &context=GKContext::anyContext) const =0
virtual QVariant *	getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const =0
virtual double	getDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double *deviation=NULL) const =0
virtual double	getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const =0
virtual GKTimeSerie *	getDataValueTS (const GKColumn *attr) const =0
virtual GKTimeSerie *	getDataValueTSByID (uint attrId) const =0
virtual int	getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual int	getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual double	getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual double	getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual QString	getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual QString	getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual bool	getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual bool	getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual GKObject *	getDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual GKObject *	getDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual QDate	getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual QDate	getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual QTime	getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual QTime	getDataValueTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual QDateTime	getDataValueDateTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual QDateTime	getDataValueDateTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual GKTimeDuration	getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual GKTimeDuration	getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

Static Public Member Functions
static GKRoadType *	getDefault (GKModel *model, bool canBeNull=false)

Static Public Attributes
static uint	speedAtt
static uint	laneCapacityAtt
static uint	minimumGapAtt
static uint	maximumGapAtt
static uint	GapReductionStartFactorAtt
static uint	GapReductionEndFactorAtt
static uint	distanceZone1Att
static uint	distanceZone2Att
static uint	onRampCooperationDistanceAtt
static uint	onRampMergingDistanceAtt
static uint	onRampFIFOAtt
static uint	cooperationAtt
static uint	aggressivenessAtt
static uint	yellowBoxBehaviourAtt
static uint	visibilityDistanceAtt
static uint	visibilityDistanceMainStreamAtt
static uint	visibilityDistanceMainStreamMesoAtt
static uint	initialSafetyMarginMesoAtt
static uint	finalSafetyMarginMesoAtt
static uint	initialGiveWayTimeFactorMesoAtt
static uint	userDefinedCostAtt
static uint	userDefinedCost2Att
static uint	userDefinedCost3Att
static uint	waitingTimeBeforeLosingTurnAtt
static uint	laneWidthVarAtt
static uint	inherentSpeedAtt
static uint	reactionTimeAtTrafficLightVariationAtt
static uint	reactionTimeAtStopVariationAtt
static uint	imprudentLaneChanging
static uint	additionalVolumeAtt
static uint	considerTwoLanesCarFollowingAtt
static uint	accelerationVariationFactorAtt
static uint	internalAtt
static uint	jamDensityAtt
static uint	reactionTimeFactorAtt
static uint	lookaheadDistanceAtt
static uint	defaultAtt
static uint	vdfAtt
static uint	drawAtt
static uint	rightExtraTypeAtt
static uint	leftExtraTypeAtt
static uint	rightExtraWidthAtt
static uint	leftExtraWidthAtt
static uint	reservedLanesVisibilityDistanceAtt
static uint	sharedLanePenalisedAtt
static uint	slowLanePenalisedAtt
static uint	hcmRoadTypeAtt
static uint	returnToInsideLaneAfterOvertaking
static uint	mesoOnRampCooperationGapAtt
static uint	mesoOnRampMergingGapAtt
Static Public Attributes inherited from GKObject
static uint	typeNameAtt
static uint	typeExternalNameAtt
static uint	revisedAtt
Static Public Attributes inherited from GKBaseObject
Py_END_ALLOW_THREADS static End uint	idAtt
static uint	nameAtt
static uint	externalIdAtt
static uint	descriptionAtt

Additional Inherited Members
Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObject *	base = (GKBaseObject*)sipCpp
	sipType = 0

Detailed Description

Use this class to specify special section attributes. The road type contains attributes for the three simulation models.

Member Enumeration Documentation

DrawMode

enum GKRoadType::DrawMode

Draw mode of this king of sections

Enumerator
eRoad
eRailway
eTramtrack
eNotDrawn
eTrafficLightsOnly

HCMRoadType

enum GKRoadType::HCMRoadType

Take into Account Fast/Slow Lanes

Enumerator
eNone
eFreeway
eMultilaneHw
eUrban

Constructor & Destructor Documentation

GKRoadType()

GKRoadType::GKRoadType

(

)

Member Function Documentation

getDefault()

static GKRoadType * GKRoadType::getDefault ( GKModel *  model, bool  canBeNull = false  )

static

Returns the current default road type from model "model"

getDrawMode()

DrawMode GKRoadType::getDrawMode

(

)

const

Draw mode of this king of sections

getFunctionalClass()

unsigned char GKRoadType::getFunctionalClass

(

)

const

The functional classification of the road type is a number from 1 to 255. FHWA defines three: 1 Arterial, 2 Collector, 3 Local Navteq defines five: 1 for high volume and max speed to 5 for low volume roads

getNonAllowedVehicles()

QVector< const GKMobileAgent * > GKRoadType::getNonAllowedVehicles

(

)

const

List of vehicles and pedestrian types that are not allowed in this road type

getNumberOfSectionsUsingRoadType()

int GKRoadType::getNumberOfSectionsUsingRoadType

(

)

const

Returns the number of sections that use this road type.

isDefault()

bool GKRoadType::isDefault

(

)

const

Returns true is this road type if the default one in its model.

isInternal()

bool GKRoadType::isInternal

(

)

const

Returns true if it is road type. Uses GKRoadType::internalAtt

setAsDefault()

void GKRoadType::setAsDefault

(

)

Set this road type as the default road type. Unmark as default any other road type (just one default road type per model).

setDrawMode()

void GKRoadType::setDrawMode

(

DrawMode

value

)

Draw mode of this king of sections

setFunctionalClass()

void GKRoadType::setFunctionalClass

(

unsigned char

value

)

See also

GKRoadType::getFunctionalClass

setNonAllowedVehicles()

void GKRoadType::setNonAllowedVehicles

(

QVector< const GKMobileAgent * >

vehicles

)

List of vehicles and pedestrian types that are not allowed in this road type

unSetAsDefault()

void GKRoadType::unSetAsDefault

(

)

Unsets this road type as the default road type.

updateSectionsInRoadType()

void GKRoadType::updateSectionsInRoadType

(

)

Applies the parameters of this road type to all of its sections.

Member Data Documentation

accelerationVariationFactorAtt

uint GKRoadType::accelerationVariationFactorAtt

static

Acceleration Factor attribute.

additionalVolumeAtt

uint GKRoadType::additionalVolumeAtt

static

Additional Volume Attribute.

aggressivenessAtt

uint GKRoadType::aggressivenessAtt

static

considerTwoLanesCarFollowingAtt

uint GKRoadType::considerTwoLanesCarFollowingAtt

static

Consider Two-Lane Car-Following model.

cooperationAtt

uint GKRoadType::cooperationAtt

static

Lane-Changing Cooperation Attribute.

defaultAtt

uint GKRoadType::defaultAtt

static

Default Attribute.

distanceZone1Att

uint GKRoadType::distanceZone1Att

static

Maximum Yield Time Factor.

Look-Ahead Distance (Micro) Attribute

distanceZone2Att

uint GKRoadType::distanceZone2Att

static

Critical Look-Ahead Distance (Micro) Attribute.

drawAtt

uint GKRoadType::drawAtt

static

Draw Attribute.

finalSafetyMarginMesoAtt

uint GKRoadType::finalSafetyMarginMesoAtt

static

Final Safety Margin Meso Attribute.

GapReductionEndFactorAtt

uint GKRoadType::GapReductionEndFactorAtt

static

Minimum Yield Time Factor.

GapReductionStartFactorAtt

uint GKRoadType::GapReductionStartFactorAtt

static

Initial Safety Margin.

hcmRoadTypeAtt

uint GKRoadType::hcmRoadTypeAtt

static

Highway Capacity Road Type

imprudentLaneChanging

uint GKRoadType::imprudentLaneChanging

static

inherentSpeedAtt

uint GKRoadType::inherentSpeedAtt

static

Inherent Speed Attribute.

initialGiveWayTimeFactorMesoAtt

uint GKRoadType::initialGiveWayTimeFactorMesoAtt

static

Yield Time Factor Meso Attribute.

initialSafetyMarginMesoAtt

uint GKRoadType::initialSafetyMarginMesoAtt

static

Initial Safety Margin Meso Attribute.

internalAtt

uint GKRoadType::internalAtt

static

Internal Attribute.

jamDensityAtt

uint GKRoadType::jamDensityAtt

static

Jam Density Attribute.

laneCapacityAtt

uint GKRoadType::laneCapacityAtt

static

Lane Capacity Attribute.

laneWidthVarAtt

uint GKRoadType::laneWidthVarAtt

static

Lane Width Attribute.

leftExtraTypeAtt

uint GKRoadType::leftExtraTypeAtt

static

Left Extra Type Attribute.

leftExtraWidthAtt

uint GKRoadType::leftExtraWidthAtt

static

Left Extra Width Attribute.

lookaheadDistanceAtt

uint GKRoadType::lookaheadDistanceAtt

static

Look-Ahead Distance (Meso) Attribute.

maximumGapAtt

uint GKRoadType::maximumGapAtt

static

Final Safety Margin.

mesoOnRampCooperationGapAtt

uint GKRoadType::mesoOnRampCooperationGapAtt

static

mesoOnRampMergingGapAtt

uint GKRoadType::mesoOnRampMergingGapAtt

static

minimumGapAtt

uint GKRoadType::minimumGapAtt

static

onRampCooperationDistanceAtt

uint GKRoadType::onRampCooperationDistanceAtt

static

Side Lane Cooperation Distance (Micro) Attribute.

onRampFIFOAtt

uint GKRoadType::onRampFIFOAtt

static

onRampMergingDistanceAtt

uint GKRoadType::onRampMergingDistanceAtt

static

Side Lane Merging Distance (Micro) Attribute.

reactionTimeAtStopVariationAtt

uint GKRoadType::reactionTimeAtStopVariationAtt

static

Additional Reaction Time At Stop (Micro) attribute.

reactionTimeAtTrafficLightVariationAtt

uint GKRoadType::reactionTimeAtTrafficLightVariationAtt

static

Additional Reaction Time At Traffic Light (Micro) attribute.

reactionTimeFactorAtt

uint GKRoadType::reactionTimeFactorAtt

static

Reaction Time Factor (Meso) Attribute.

reservedLanesVisibilityDistanceAtt

uint GKRoadType::reservedLanesVisibilityDistanceAtt

static

Visibility Distance for the reserved lanes, if any.

returnToInsideLaneAfterOvertaking

uint GKRoadType::returnToInsideLaneAfterOvertaking

static

Return to curbside lane after Overtaking attribute.

rightExtraTypeAtt

uint GKRoadType::rightExtraTypeAtt

static

Right Extra Type Attribute.

rightExtraWidthAtt

uint GKRoadType::rightExtraWidthAtt

static

Right Extra Width Attribute.

sharedLanePenalisedAtt

uint GKRoadType::sharedLanePenalisedAtt

static

slowLanePenalisedAtt

uint GKRoadType::slowLanePenalisedAtt

static

Penalise Shared Lanes

speedAtt

uint GKRoadType::speedAtt

static

Speed Attribute.

userDefinedCost2Att

uint GKRoadType::userDefinedCost2Att

static

User-Defined Cost 2 Attribute.

userDefinedCost3Att

uint GKRoadType::userDefinedCost3Att

static

User-Defined Cost 3 Attribute.

userDefinedCostAtt

uint GKRoadType::userDefinedCostAtt

static

User-Defined Cost 1 Attribute.

vdfAtt

uint GKRoadType::vdfAtt

static

VDF Attribute.

visibilityDistanceAtt

uint GKRoadType::visibilityDistanceAtt

static

Visibility Distance to yield micro Attribute.

visibilityDistanceMainStreamAtt

uint GKRoadType::visibilityDistanceMainStreamAtt

static

Visibility Distance Main Stream Micro Attribute.

visibilityDistanceMainStreamMesoAtt

uint GKRoadType::visibilityDistanceMainStreamMesoAtt

static

Visibility Distance Main Stream Meso Attribute.

waitingTimeBeforeLosingTurnAtt

uint GKRoadType::waitingTimeBeforeLosingTurnAtt

static

Additional Waiting Time Before Missing Turn Attribute.

yellowBoxBehaviourAtt

uint GKRoadType::yellowBoxBehaviourAtt

static

Lane-Changing Aggressiveness.

Yellow Box Behavior Attribute