Abstract Class Reference

Classes
struct	DTAIterationTask

Public Member Functions
const DTAPTStop *	getOrigin () const
const DTAPTStop *	getDestination () const
const GKFunctionCost *	getFareFunction () const
double	getDistance () const
	DTASimulator ()
virtual void	configureDTAObjects ()=0
virtual void	configureIteration (int iterationNumber)=0
virtual void	postIter (bool iscancel)=0
virtual void	simulateStepOneShot ()=0
virtual double	getTime () const =0
virtual bool	isStationary () const =0
virtual double	getTimeSta () const =0
virtual bool	canFinishNetworkLoadingDTA () const =0
virtual void	dynamicalRouteChange ()=0
virtual void	deactivateOutputs ()=0
virtual void	activateOutputs ()=0
virtual bool	slowOutputsActive () const =0
const GKSimulatedObject *	object () const
const GKPoint &	position () const
uint	internId () const
qint8	index () const
double	length () const
float	cost (const DTAManager *, const DTAVehicleType *, int) const
float	travelTime (const DTAManager *, const DTAVehicleType *, int) const
bool	isVehicleAllowed (const DTAVehicleType *, int) const
	GKPrintLayoutItem (double x, double y, double width, double height)
	if (base)
Py_END_ALLOW_THREADS virtual End	~GKPrintLayoutItem ()
void	setLayout (GKPrintLayout *_layout)
GKPrintLayout *	getLayout () const
QPointF	getPosInPage () const
QSizeF	getSizeInPage () const
QSizeF	getSizeInPageInMM () const
GKBBox	getBBoxInPage () const
bool	setX (double x)
bool	setY (double y)
bool	setWidth (double)
bool	setHeight (double)
double	getX () const
double	getY () const
double	getWidth () const
double	getHeight () const
GKBBox	getBBox () const
bool	drawFrame () const
void	setDrawFrame (bool value)
bool	useBckColor () const
void	setUseBckColor (bool value)
QColor	getBckColor () const
void	setBckColor (QColor color)
virtual QString	getType ()=0
void	setSelected (bool s)
bool	isSelected () const
void	setLocked (bool locked)
bool	isLocked () const
void	setDisableSimpleDrawing (bool disableSimpleDraw)
bool	isSimpleDrawDisabled () const
virtual GKPrintLayoutItem *	clone ()
quint32	getTick () const

Public Attributes
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKPrintLayoutItem *	base = (GKPrintLayoutItem*)sipCpp
	sipType = 0

Static Public Attributes
static const QString	sDeltaProperty
static const QString	sDeltaWidthProperty
static const QString	sDeltaHeightProperty

Detailed Description

Aimsun path class. This is the base class for all paths .

Aimsun Dynamic Traffic Assignment simulator front-end.

This is the base class for all dynamic traffic assignment simulators. For example:

• GAimsunSimulator
• AMesoDTASimulator The simulatior can hold either a Stochastic Route Choice simulation or an Dyncamic User Equilibrium simulation.

Abstract Class implemented by the differents items to be drawn. The positons and the size of the elements are relative to the PageSize from its owner: GKPrintLayout

See also

GKPrintLayout

Constructor & Destructor Documentation

~GKPrintLayoutItem()

Py_END_ALLOW_THREADS virtual End Abstract::~GKPrintLayoutItem ( )

virtual

Member Function Documentation

activateOutputs()

virtual void Abstract::activateOutputs ( )

pure virtual

Active statistics.

canFinishNetworkLoadingDTA()

virtual bool Abstract::canFinishNetworkLoadingDTA ( ) const

pure virtual

Returns true if simulation can finish the DNL simulation. This is when the simulation time is greater than the total simulation duration.

clone()

virtual GKPrintLayoutItem * Abstract::clone ( )

virtual

configureDTAObjects()

virtual void Abstract::configureDTAObjects ( )

pure virtual

It binds objects from the dynamic network loading model(micro or meso) to DTA objects.

configureIteration()

virtual void Abstract::configureIteration ( int  iterationNumber )

pure virtual

This function is provided for convenience. It has to be reimplemented by the micro or meso simulators in order to initilize its respective internal classes. It's called every time before starting the iteration simulation.

cost()

float Abstract::cost	(	const DTAManager *	,
		const DTAVehicleType *	,
		int
	)		const

deactivateOutputs()

virtual void Abstract::deactivateOutputs ( )

pure virtual

Deactivate statistics.

drawFrame()

bool Abstract::drawFrame

(

)

const

Returns true if set to draw a black frame at the border of the element. False otherwise

DTASimulator()

Abstract::DTASimulator

(

)

dynamicalRouteChange()

virtual void Abstract::dynamicalRouteChange ( )

pure virtual

This function is provided for convenience. It has to be reimplemented by the micro or meso simulators in order to run the dynamic route change. See Aimsun Next Hybrid Meso-Micro model explanation in the manual.

getBBox()

GKBBox Abstract::getBBox

(

)

const

getBBoxInPage()

GKBBox Abstract::getBBoxInPage

(

)

const

getBckColor()

QColor Abstract::getBckColor

(

)

const

getDestination()

const DTAPTStop * Abstract::getDestination

(

)

const

getDistance()

double Abstract::getDistance

(

)

const

getFareFunction()

const GKFunctionCost * Abstract::getFareFunction

(

)

const

getHeight()

double Abstract::getHeight

(

)

const

getLayout()

GKPrintLayout * Abstract::getLayout

(

)

const

getOrigin()

const DTAPTStop * Abstract::getOrigin

(

)

const

getPosInPage()

QPointF Abstract::getPosInPage

(

)

const

The relative (to the layout) position of this item.

getSizeInPage()

QSizeF Abstract::getSizeInPage

(

)

const

getSizeInPageInMM()

QSizeF Abstract::getSizeInPageInMM

(

)

const

getTick()

quint32 Abstract::getTick

(

)

const

getTime()

virtual double Abstract::getTime ( ) const

pure virtual

Returns the current time.

getTimeSta()

virtual double Abstract::getTimeSta ( ) const

pure virtual

Returns the current time using the initial time as the starting time. During the warm-up the return value is the initial time less the corresponding warm-up simulation time.

getType()

virtual QString Abstract::getType ( )

pure virtual

getWidth()

double Abstract::getWidth

(

)

const

getX()

double Abstract::getX

(

)

const

getY()

double Abstract::getY

(

)

const

GKPrintLayoutItem()

Abstract::GKPrintLayoutItem	(	double	x,
		double	y,
		double	width,
		double	height
	)

if()

Abstract::if ( base  )

inline

References GKSystem::getSystem().

index()

qint8 Abstract::index

(

)

const

internId()

uint Abstract::internId

(

)

const

isLocked()

bool Abstract::isLocked

(

)

const

isSelected()

bool Abstract::isSelected

(

)

const

isSimpleDrawDisabled()

bool Abstract::isSimpleDrawDisabled

(

)

const

isStationary()

virtual bool Abstract::isStationary ( ) const

pure virtual

Returns true if current time is greater than the warm-up time.

isVehicleAllowed()

bool Abstract::isVehicleAllowed	(	const DTAVehicleType *	,
		int
	)		const

length()

double Abstract::length

(

)

const

object()

const GKSimulatedObject * Abstract::object

(

)

const

position()

const GKPoint & Abstract::position

(

)

const

postIter()

virtual void Abstract::postIter ( bool  iscancel )

pure virtual

This function is provided for convenience. It has to be reimplemented by the micro or meso simulators in order to initilize its respective internal classes. It's called every time a iteration simulation is finished.

setBckColor()

void Abstract::setBckColor

(

QColor

color

)

setDisableSimpleDrawing()

void Abstract::setDisableSimpleDrawing

(

bool

disableSimpleDraw

)

setDrawFrame()

void Abstract::setDrawFrame

(

bool

value

)

Use true to draw a black frame at the border of the element. False otherwise

setHeight()

bool Abstract::setHeight

(

double

)

Sets Height. Returns false if the specified value as been bounded because out-of-page, else return true.

setLayout()

void Abstract::setLayout

(

GKPrintLayout *

_layout

)

setLocked()

void Abstract::setLocked

(

bool

locked

)

setSelected()

void Abstract::setSelected

(

bool

s

)

setUseBckColor()

void Abstract::setUseBckColor

(

bool

value

)

setWidth()

bool Abstract::setWidth

(

double

)

Sets Width. Returns false if the specified value as been bounded because out-of-page, else return true.

setX()

bool Abstract::setX

(

double

x

)

Sets X. Returns false if the specified value as been bounded because out-of-page, else return true.

setY()

bool Abstract::setY

(

double

y

)

Sets Y. Returns false if the specified value as been bounded because out-of-page, else return true.

simulateStepOneShot()

virtual void Abstract::simulateStepOneShot ( )

pure virtual

Simulated a one shot simulation step.

slowOutputsActive()

virtual bool Abstract::slowOutputsActive ( ) const

pure virtual

Returns the current status of statistics. True means that is not gathering statistics false is gathering.

travelTime()

float Abstract::travelTime	(	const DTAManager *	,
		const DTAVehicleType *	,
		int
	)		const

useBckColor()

bool Abstract::useBckColor

(

)

const

Member Data Documentation

base

ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKPrintLayoutItem* Abstract::base = (GKPrintLayoutItem*)sipCpp

sDeltaHeightProperty

const QString Abstract::sDeltaHeightProperty

static

sDeltaProperty

const QString Abstract::sDeltaProperty

static

sDeltaWidthProperty

const QString Abstract::sDeltaWidthProperty

static

sipType

Abstract::sipType = 0