GKRoadPricing Class Reference

Inheritance diagram for GKRoadPricing:

Public Types
enum	GKRoadPricingType { eEntry , eExit }
Public Types inherited from GKSectionChange
enum	TargetType { eSection = 0 , eGroup = 1 , eRoadType = 2 , eTurn = 3 }
Public Types inherited from GKScenarioChange
enum	GKScenarioChangeType {   eLaneClosing , eSpeedChange , eForceTurning , eDestinationChange ,   eIncident , eDemandModification , eTurningClosing , eControlPlanChange ,   ePeriodicIncident , eSectionBehaviouralParametersChange , eTurningBehaviouralParametersChange , eDisableReserved ,   eRoadPricing , eRoadPricingChange , eMeteringOnRampChange , eIntersectionPlanChange ,   eForceEnrouteAssignment , eTurningCooperation , eParkAndRideChange , eNone }
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
	GKRoadPricing ()
GKScenarioChangeType	getChangeType () const
GKRoadPricingType	getRoadPricingType () const
void	setRoadPricingType (const GKRoadPricingType atype)
const GKCentroidConfiguration *	getCentroidConfiguration () const
void	setCentroidConfiguration (const GKCentroidConfiguration *config)
void	setOrigin (const GKCentroid *centroid)
void	setDestination (const GKCentroid *centroid)
const GKCentroid *	getOrigin () const
const GKCentroid *	getDestination () const
void	setHOTSection (const GKSection *section)
const GKSection *	getHOTSection () const
void	setGeneralPurposeSection (const GKSection *section)
const GKSection *	getGeneralPurposeSection () const
virtual GKPoint	getPosition () const
bool	costCalculationIsToNextSegment () const
void	setCostCalculationToNextSegment (bool value)
bool	costCalculationIsToEndOfCurrentZone () const
void	setCostCalculationToEndOfCurrentZone (bool value)
bool	costCalculationIsToEndOfTrip () const
Public Member Functions inherited from GKSectionChange
	GKSectionChange ()
TargetType	getTargetType () const
void	setTargetType (TargetType targetType)
void	setSection (const GKSection *asection)
const GKSection *	getSection () const
QVector< int >	getSectionsAffected () const
void	setChangeTarget (const GKObject *asection)
const GKObject *	getChangeTarget () const
void	setFromLane (int value)
int	getFromLane () const
void	setToLane (int value)
int	getToLane () const
void	setFromSegment (int value)
int	getFromSegment () const
void	setToSegment (int value)
int	getToSegment () const
void	setOffset (float o)
void	setLength (float l)
float	getOffset () const
float	getLength () const
float	getOffsetAdaptedToLane (int lane) const
float	getLengthAdaptedToLane (int lane) const
Public Member Functions inherited from GKScenarioChange
	GKScenarioChange ()
virtual GKScenarioChangeType	getChangeType () const =0
virtual bool	canBeUsed (const GKExperiment *where, const QSet< GKGeoObject * > &inObjects) const
const QString &	getComplianceLevel () const
void	setComplianceLevel (const QString &value)
GKVehicleClass *	getVehicleClass () const
void	setVehicleClass (GKVehicleClass *vehClass)
const QString &	getMessage (GKVMS *vms) const
void	setMessage (GKVMS *vms, const QString &message)
void	removeMessage (GKVMS *vms)
void	clearMessages ()
void	activateMessagesInVMS () const
void	deactivateMessagesInVMS () const
void	setPolicy (GKPolicy *apolicy)
GKPolicy *	getPolicy () const
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 Attributes
static uint	typeAtt
static uint	configurationAtt
static uint	originAtt
static uint	destinationAtt
static uint	nextSectionAtt
static uint	thresholdActionAtt
static uint	visibilityDistanceAtt
static uint	zoneAtt
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

The user must specify the section where the action is applied and the turn that vehicles will be forced to take if willing to either enter the priced road or exit it if alredy in. Then the user must specify which vehicles on the section will be affected by this action, by specifying the OD pairs affected. Finally, the user can choose the vehicle class considered and the level of compliance for this action.

Member Enumeration Documentation

GKRoadPricingType

enum GKRoadPricing::GKRoadPricingType

Set whether the action will make vehicles enter or exit the priced road.

Enumerator
eEntry
eExit

Constructor & Destructor Documentation

GKRoadPricing()

GKRoadPricing::GKRoadPricing

(

)

Member Function Documentation

costCalculationIsToEndOfCurrentZone()

bool GKRoadPricing::costCalculationIsToEndOfCurrentZone

(

)

const

Returns whether the cost calculation to take the decision considers the remainder of the current zone.

costCalculationIsToEndOfTrip()

bool GKRoadPricing::costCalculationIsToEndOfTrip

(

)

const

Returns whether the cost calculation to take the decision considers the remainder of the trip.

costCalculationIsToNextSegment()

bool GKRoadPricing::costCalculationIsToNextSegment

(

)

const

The following option will contain which Costs to compare to take the decision will be considered. The options are:

1. next segment
2. remainder of the current zone
3. remainder of the trip The three options can co-exist but when no one is selected, next segment will be automatically considered.

Returns whether the cost calculation to take the decision considers the next segment.

getCentroidConfiguration()

const GKCentroidConfiguration * GKRoadPricing::getCentroidConfiguration

(

)

const

Gets the related centroid configuration

getChangeType()

GKScenarioChangeType GKRoadPricing::getChangeType ( ) const

virtual

Reimplemented from class GKScenarioChange.

Implements GKScenarioChange.

getDestination()

const GKCentroid * GKRoadPricing::getDestination

(

)

const

Gets the destination centroid of the affected car. Can be None, means ANY.

getGeneralPurposeSection()

const GKSection * GKRoadPricing::getGeneralPurposeSection

(

)

const

Gets the general purpose section. This is where the vehicles will go into if the action is satisfied.

getHOTSection()

const GKSection * GKRoadPricing::getHOTSection

(

)

const

Gets the HOT section. This is where the vehicles will go into if the action is satisfied.

getOrigin()

const GKCentroid * GKRoadPricing::getOrigin

(

)

const

Gets the origin centroid of the affected car. Can be None, means ANY.

getPosition()

virtual GKPoint GKRoadPricing::getPosition ( ) const

virtual

GKScenarioChange override.

getRoadPricingType()

GKRoadPricingType GKRoadPricing::getRoadPricingType

(

)

const

Gets the type of road pricing, either entry or exit.

setCentroidConfiguration()

void GKRoadPricing::setCentroidConfiguration

(

const GKCentroidConfiguration *

config

)

Sets the related centroid configuration

setCostCalculationToEndOfCurrentZone()

void GKRoadPricing::setCostCalculationToEndOfCurrentZone

(

bool

value

)

Sets the cost calculation to take the decision to consider the remainder of the current zone when true and not to consider it otherwise.

setCostCalculationToNextSegment()

void GKRoadPricing::setCostCalculationToNextSegment

(

bool

value

)

Sets the cost calculation to take the decision to consider the next segment when true and not to consider it otherwise.

setDestination()

void GKRoadPricing::setDestination

(

const GKCentroid *

centroid

)

Sets the destination centroid of the affected car. Can be None, means ANY.

setGeneralPurposeSection()

void GKRoadPricing::setGeneralPurposeSection

(

const GKSection *

section

)

Sets the general purpose section. This is where the vehicles will go into if the action is satisfied.

setHOTSection()

void GKRoadPricing::setHOTSection

(

const GKSection *

section

)

Sets the HOT section. This is where the vehicles will go into if the action is satisfied.

setOrigin()

void GKRoadPricing::setOrigin

(

const GKCentroid *

centroid

)

Sets the origin centroid of the affected car. Can be None, means ANY.

setRoadPricingType()

void GKRoadPricing::setRoadPricingType

(

const GKRoadPricingType

atype

)

Sets the type of road pricing, either entry or exit.

Member Data Documentation

configurationAtt

uint GKRoadPricing::configurationAtt

static

destinationAtt

uint GKRoadPricing::destinationAtt

static

nextSectionAtt

uint GKRoadPricing::nextSectionAtt

static

originAtt

uint GKRoadPricing::originAtt

static

thresholdActionAtt

uint GKRoadPricing::thresholdActionAtt

static

typeAtt

uint GKRoadPricing::typeAtt

static

Extra condition for the forced turn when using a OD-based simulation. A section must be on the path to consider the action.

visibilityDistanceAtt

uint GKRoadPricing::visibilityDistanceAtt

static

Visibility Distance for this close lane action for the dynamic simulators in m (GKColumn::Double).

zoneAtt

uint GKRoadPricing::zoneAtt

static

Sets the cost calculation to take the decision to consider the remainder of the trip when true and not to consider it otherwise.

This attribute represents the zone for tarifary purposes where this action is located