GKPublicLine Class Reference

Inheritance diagram for GKPublicLine:

Public Member Functions
	GKPublicLine ()
QVector< GKBusStop * >	getStops () const
void	setStops (const QVector< GKBusStop * > &_stops)
QVector< GKSection * >	getSections (GKBusStop *origin, GKBusStop *destination) const
void	addTimeTable (GKPublicLineTimeTable *)
void	removeTimeTable (GKPublicLineTimeTable *)
void	removeTimeTables ()
const QVector< GKPublicLineTimeTable * > &	getTimeTables () const
bool	isStopUsed (const GKBusStop *) const
int	getIndexAppearance (const GKBusStop *stop, int indexRoute) const
int	getIndexSection (const GKBusStop *stop, int indexAppearance) const
virtual void	add (GKSection *section, GKSection *after)
void	clear ()
void	clearStopToStopFunctions ()
double	getDistanceFare () const
void	setDistanceFare (double iFare)
double	getBoardingFare () const
void	setBoardingFare (double iFare)
double	getTimeTableStopToStopDelay (GKBusStop *origin, GKBusStop *destination, GKGenericExperiment *iExperiment) const
GKFunctionCost *	getDelayFunction (GKBusStop *origin, GKBusStop *destination) const
void	setDelayFunction (GKBusStop *origin, GKBusStop *destination, GKFunctionCost *iDelayFunction)
GKFunctionCost *	getFareFunction (GKBusStop *origin, GKBusStop *destination) const
void	setFareFunction (GKBusStop *origin, GKBusStop *destination, GKFunctionCost *iFareFunction)
GKFunctionCost *	crowdDiscomfortFunction () const
void	setCrowdDiscomfortFunction (GKFunctionCost *aFunction)
void	setProblemNet (GKProblemNet *aProblemNet)
GKProblemNet *	getProblemNet () const
SIP_PYLIST	getPTSectionData () const
	foreach (const GKPTSectionData &data, sipCpp->getPTSectionData())
Public Member Functions inherited from GKRoute
	GKRoute ()
const QList< GKSection * > &	getRoute () const
void	setRoute (const QList< GKSection * > &)
virtual void	add (GKSection *section, GKSection *after=NULL)
virtual void	prepend (GKSection *section, GKSection *before=NULL)
virtual QVector< GKSection * >	remove (GKSection *)
virtual void	clear ()
virtual bool	use (const GKSection *) const
virtual bool	isCorrect (int *errorID=NULL, int *indexSection=NULL, int *previousSection=NULL, int scenarioId=-1) const
GKCoord	length3D () const
Public Member Functions inherited from GKGeoObject
	GKGeoObject ()
virtual void	setSelected (bool newState)
virtual bool	isSelected () const
bool	canBeModified () const
bool	canBeEdited () const
virtual bool	canBeGrouped () const
int	getMark () const
void	setMark (int newMark)
void	addMark (int newMark)
void	unmark ()
const QVector< int > *	getMarks () const
uint	getNumberOfMarks () const
GKLayer *	getLayer () const
void	setLayer (GKLayer *alayer)
virtual void	translate (const GKPoint &delta)
virtual void	rotate (const GKPoint &center, double angle)
virtual void	scale (const GKPoint &)
virtual GKCoord	getAltitude () const
virtual void	setAltitude (GKCoord value)
void	addTopObject (GKGeoObject *)
QSet< GKGeoObject * > *	getTopObjects () const
GKGeoObject *	getBottomObject () const
void	setLabeled (bool value)
bool	isLabeled () const
GKGeoContainer	getContainedWay (const GKPoints &points, const GKBBox &bboxPoints) const
virtual GKGeoContainer	doGetContainedWay (const GKBBox &myBBox, const GKPoints &points, const GKBBox &bboxPoints) const
GK::ConnectionType	objectConnectionType (const GKGeoObject *object) const
QSet< GKObjectConnection * >	getConnections () const
QSet< GKObjectConnection * >	getConnections (const GKGeoObject *) const
bool	anyConnection (const GKGeoObject *) const
virtual void	addConnection (GKObjectConnection *)
virtual void	removeConnection (GKObjectConnection *, GK::ObjectDeletionBehaviour)
virtual void	changeConnectionObject (GKGeoObject *oldObject, GKGeoObject *newObject, GK::ConnectionType connectionType=GK::eConnectionUndefined)
virtual void	removeAllConnections (GK::ObjectDeletionBehaviour)
virtual bool	acceptConnection (GKGeoObject *object) const
virtual GKGeoObjectCutCmd *	getCutCmd (const GKPoint &from, const GKPoint &to, bool keepConnection)
virtual bool	exists (quint32 scenarioId) 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

Public Attributes
MethodCode PyObject *	pylist
	pylist = PyList_New(0)
	sipRes = pylist
Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObject *	base = (GKBaseObject*)sipCpp
	sipType = 0

Additional Inherited Members
Public Types inherited from GKGeoObject
enum	GKGeoContainer { eNothing = 0 , ePartially = 1 , eTotally = 2 }
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
Static Public Attributes inherited from GKGeoObject
static uint	markAtt
static uint	altitudeAtt
static uint	numberOfConnectionsAtt
static uint	layerAtt
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

Detailed Description

A transit route, its stops and the associated timetables.

The internal name of the transit line folder is: "GKModel::publicLines" The external name is "Transit Lines and Plans"

Constructor & Destructor Documentation

GKPublicLine()

GKPublicLine::GKPublicLine

(

)

Member Function Documentation

add()

virtual void GKPublicLine::add ( GKSection *  section, GKSection *  after  )

virtual

Add a section to the route either to the end (after == None or after is not in the route) or after the section "after"

Reimplemented from GKRoute.

addTimeTable()

void GKPublicLine::addTimeTable

(

GKPublicLineTimeTable *

)

Adds a timetable. The pointer is adopted.

clear()

void GKPublicLine::clear ( )

virtual

Removes all the sections (route) and stops from this line

Reimplemented from GKRoute.

clearStopToStopFunctions()

void GKPublicLine::clearStopToStopFunctions

(

)

Removes all stop to stop functions defined

crowdDiscomfortFunction()

GKFunctionCost * GKPublicLine::crowdDiscomfortFunction

(

)

const

Get the crowd discomfort function

foreach()

GKPublicLine::foreach ( const GKPTSectionData &  data, sipCpp->  getPTSectionData()  )

inline

References pylist.

getBoardingFare()

double GKPublicLine::getBoardingFare

(

)

const

Gets the boarding fare for this line.

getDelayFunction()

GKFunctionCost * GKPublicLine::getDelayFunction	(	GKBusStop *	origin,
		GKBusStop *	destination
	)		const

Gets the delay function for given origin and destination Transit Stop

getDistanceFare()

double GKPublicLine::getDistanceFare

(

)

const

Gets the distance fare for this line.

getFareFunction()

GKFunctionCost * GKPublicLine::getFareFunction	(	GKBusStop *	origin,
		GKBusStop *	destination
	)		const

Gets the distance fare function from Transit Stop origin to Transit Stop destination

getIndexAppearance()

int GKPublicLine::getIndexAppearance	(	const GKBusStop *	stop,
		int	indexRoute
	)		const

Returns the number stop appearances before position indexRoute (indexRoute is also considered).

getIndexSection()

int GKPublicLine::getIndexSection	(	const GKBusStop *	stop,
		int	indexAppearance
	)		const

Returns the index section (1..N) of the stop considering the index appearance of the stop.

getProblemNet()

GKProblemNet * GKPublicLine::getProblemNet

(

)

const

Returns the Subnetwork this transit line belongs to.

getPTSectionData()

SIP_PYLIST GKPublicLine::getPTSectionData

(

)

const

get the list with transit section data QVector< GKPTSectionData* >

getSections()

QVector< GKSection * > GKPublicLine::getSections	(	GKBusStop *	origin,
		GKBusStop *	destination
	)		const

Returns all transit sections between origin and destination stop.

getStops()

QVector< GKBusStop * > GKPublicLine::getStops

(

)

const

Returns all the transit stops of this line. It will return a vector with as many positions as sections in the transit line, with None where there is no stop.

getTimeTables()

const QVector< GKPublicLineTimeTable * > & GKPublicLine::getTimeTables

(

)

const

Returns all the timetables of this line

getTimeTableStopToStopDelay()

double GKPublicLine::getTimeTableStopToStopDelay	(	GKBusStop *	origin,
		GKBusStop *	destination,
		GKGenericExperiment *	iExperiment
	)		const

Gets the average delay from Transit Stop origin to Transit Stop destination for active scenario (weighted by schedule duration)

isStopUsed()

bool GKPublicLine::isStopUsed

(

const GKBusStop *

)

const

Returns true if the stop is used in this line.

removeTimeTable()

void GKPublicLine::removeTimeTable

(

GKPublicLineTimeTable *

)

Removes a timetable from this line. The timetable is not deleted.

removeTimeTables()

void GKPublicLine::removeTimeTables

(

)

Removes and deleted all the timetables from this line.

setBoardingFare()

void GKPublicLine::setBoardingFare

(

double

iFare

)

Sets the boarding fare for this line.

setCrowdDiscomfortFunction()

void GKPublicLine::setCrowdDiscomfortFunction

(

GKFunctionCost *

aFunction

)

Set the crowd discomfort function

setDelayFunction()

void GKPublicLine::setDelayFunction	(	GKBusStop *	origin,
		GKBusStop *	destination,
		GKFunctionCost *	iDelayFunction
	)

Sets the delay time function from Transit Stop origin to Transit Stop destination

setDistanceFare()

void GKPublicLine::setDistanceFare

(

double

iFare

)

Sets the distance fare for this line.

setFareFunction()

void GKPublicLine::setFareFunction	(	GKBusStop *	origin,
		GKBusStop *	destination,
		GKFunctionCost *	iFareFunction
	)

Sets the distance fare function from Transit Stop origin to Transit Stop destination

setProblemNet()

void GKPublicLine::setProblemNet

(

GKProblemNet *

aProblemNet

)

Sets the Subnetwork this transit line belongs to.

setStops()

void GKPublicLine::setStops

(

const QVector< GKBusStop * > &

_stops

)

Sets all the transit stops of this line. The vector has to have as many positions as sections in the transit line, with None where there is no stop.

Member Data Documentation

pylist [1/2]

MethodCode PyObject* GKPublicLine::pylist

Referenced by foreach().

pylist [2/2]

GKPublicLine::pylist = PyList_New(0)

sipRes

GKPublicLine::sipRes = pylist