Inheritance diagram for GKCentroidConfiguration:

Public Member Functions
	GKCentroidConfiguration ()

GKProblemNet *	getProblemNet () const

void	setProblemNet (GKProblemNet *pn)

void	addCentroid (GKCentroid *)

void	removeCentroid (GKCentroid *)

const QVector< GKCentroid * > &	getCentroids () const

const QVector< GKCentroid * > &	getCentroidsInOrder ()

void	orderCentroids ()

GKCentroid *	getCentroidByName (const QString &name, bool origin=true) const

GKCentroid *	getCentroidByExternalId (const QString &eid, bool origin=true) const

QVector< GKCentroid * >	getOriginCentroids () const

QVector< GKCentroid * >	getDestinationCentroids () const

bool	contains (const GKCentroid *) const

void	addODMatrix (GKODMatrix *)

void	removeODMatrix (GKODMatrix *)

const GKFolder *	getODMatrices () const

void	addRoute (GKODRoute *)

void	removeRoute (GKODRoute *)

const GKFolder *	getRoutes () const

void	addVector (GKObject *pn)

void	removeVector (GKObject *pn)

const GKFolder *	getVectors () const

void	markEntrancesAndExits () const

void	activate ()

bool	isActive () const

void	desactivate ()

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 GKCentroidConfiguration *	getActualCentroidConfiguration (GKModel *, bool=false)

Static Public Attributes
static uint	subnetworkAtt

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 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 Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObject *	base = (GKBaseObject*)sipCpp

	sipType = 0

Detailed Description

Centroid configuration: a collection of centroids. A net can have several configurations but only one can be active during a simulation. Any OD matrix and OD route are valid only for a particular configuration.

Used to have centroids for a project and centroids for a subnetwork in the same model.

The internal name of the centroid configuration folder is:

When is the model: "GKModel::centroidsConf"
When in a subnetwork: "GKProblemNet::centroidsConf" The external name is "Centroid Configurations"

You can access the centroids in a configuration using the GKCentroidConfiguration::getCentroids method. Note that using the catalog will give you all the centroids no matter the configuration to use.

Constructor & Destructor Documentation

◆ GKCentroidConfiguration()

GKCentroidConfiguration::GKCentroidConfiguration ( )

Member Function Documentation

◆ activate()

void GKCentroidConfiguration::activate ( )

Activates this configuration in the geomodel and desactivates the current configuration before.

◆ addCentroid()

void GKCentroidConfiguration::addCentroid ( GKCentroid * )

Adds a centroid to the configuration. Matrices on this configuration will be updated.

◆ addODMatrix()

void GKCentroidConfiguration::addODMatrix ( GKODMatrix * )

Adds a matrix to this configuration.

◆ addRoute()

void GKCentroidConfiguration::addRoute ( GKODRoute * )

Adds a route to this configuration.

◆ addVector()

void GKCentroidConfiguration::addVector ( GKObject * pn )

Adds a vector to this configuration.

◆ contains()

bool GKCentroidConfiguration::contains ( const GKCentroid * ) const

Returns true if the centroid obj is part of this configuration.

◆ desactivate()

void GKCentroidConfiguration::desactivate ( )

Desactivates this configuration

◆ getActualCentroidConfiguration()

static GKCentroidConfiguration * GKCentroidConfiguration::getActualCentroidConfiguration	(	GKModel *	,
		bool	= `false`
	)

static

Returns the current centroid configuration active in the model. To set the actual centroid configuration use the GKCentroidConfiguration::activate method.

If no centroid configuration is active and createIt is false then None is returned. If createIt is true then a new centroid configuration is created and it is set as de active one.

◆ getCentroidByExternalId()

GKCentroid * GKCentroidConfiguration::getCentroidByExternalId	(	const QString &	eid,
		bool	origin = `true`
	)		const

Returns the origin or destination centroid (depending on the second parameter) in this centroid configuration having the entered external ID. NULL otherwise. Unconnected centroids will not be found using this function.

◆ getCentroidByName()

GKCentroid * GKCentroidConfiguration::getCentroidByName	(	const QString &	name,
		bool	origin = `true`
	)		const

returns any existing centroid having the entered name. NULL otherwise

◆ getCentroids()

const QVector< GKCentroid * > & GKCentroidConfiguration::getCentroids ( ) const

Returns the centroids on this configuration.

◆ getCentroidsInOrder()

const QVector< GKCentroid * > & GKCentroidConfiguration::getCentroidsInOrder ( )

Sorts by identifier and returns the centroids on this configuration.

◆ getDestinationCentroids()

QVector< GKCentroid * > GKCentroidConfiguration::getDestinationCentroids ( ) const

Returns a list of all the (possible) destination centroids. It looks at the centroid connection but do not look to see if these connections are used or not (in a matrix).

◆ getODMatrices()

const GKFolder * GKCentroidConfiguration::getODMatrices ( ) const

Gets all the matrices from this configuration.

◆ getOriginCentroids()

QVector< GKCentroid * > GKCentroidConfiguration::getOriginCentroids ( ) const

Returns a list of all the (possible) origin centroids. It looks at the centroid connection but do not look to see if these connections are used or not (in a matrix).

◆ getProblemNet()

GKProblemNet * GKCentroidConfiguration::getProblemNet ( ) const

Returns the Subnetwork this centroid configuration belongs to.

◆ getRoutes()

const GKFolder * GKCentroidConfiguration::getRoutes ( ) const

Gets all the routes from this configuration.

◆ getVectors()

const GKFolder * GKCentroidConfiguration::getVectors ( ) const

Gets all the vectors from this configuration.

◆ isActive()

bool GKCentroidConfiguration::isActive ( ) const

Returns true if this configuration is the active one in the model.

◆ markEntrancesAndExits()

void GKCentroidConfiguration::markEntrancesAndExits ( ) const

Mark all sections (and detectors) connected to centroids as entrance or exit (or both)

◆ orderCentroids()

void GKCentroidConfiguration::orderCentroids ( )

Sorts by identifier the centroids on this configuration.

◆ removeCentroid()

void GKCentroidConfiguration::removeCentroid ( GKCentroid * )

Removes a centroid from the configuration. Matrices on this configuration will be updated.

◆ removeODMatrix()

void GKCentroidConfiguration::removeODMatrix ( GKODMatrix * )

Removes a matrix from this configuration.

◆ removeRoute()

void GKCentroidConfiguration::removeRoute ( GKODRoute * )

Removes a route from this configuration.

◆ removeVector()

void GKCentroidConfiguration::removeVector ( GKObject * pn )

Removes a vector from this configuration.

◆ setProblemNet()

void GKCentroidConfiguration::setProblemNet ( GKProblemNet * pn )

Sets the Subnetwork this centroid configuration belongs to.

Member Data Documentation

◆ subnetworkAtt

uint GKCentroidConfiguration::subnetworkAtt