Aimsun Next Scripting: GKTimeDuration Class Reference
Aimsun Next Scripting  22
Public Member Functions | Static Public Member Functions | List of all members
GKTimeDuration Class Reference

Public Member Functions

 GKTimeDuration ()
 
 GKTimeDuration (int h, int m, int s)
 
 GKTimeDuration (const QTime &qtime)
 
bool isNull () const
 
bool isValid () const
 
uint hour () const
 
uint minute () const
 
uint second () const
 
uint msec () const
 
uint toMilliseconds () const
 
QString toString (bool forceMilliseconds=false) const
 
bool setHMS (int h, int m, int s, int milliseconds=0)
 
QTime toQTime () const
 
uint toSeconds (uint *milliseconds=NULL) const
 
uint toDays (uint *milliseconds=NULL) const
 
float toMinutes () const
 
float toHours () const
 
GKTimeDuration addSecs (int s) const
 
int secsTo (const GKTimeDuration &) const
 
GKTimeDuration addMSecs (int) const
 
int msecsTo (const GKTimeDuration &) const
 

Static Public Member Functions

static GKTimeDuration durationBetweenTimes (const QTime &, const QTime &)
 
static bool isValid (int, int, int)
 
static GKTimeDuration fromString (const QString &)
 

Detailed Description

In Aimsun events starts at a given moment and have a duration instead of an end time.

Constructor & Destructor Documentation

◆ GKTimeDuration() [1/3]

GKTimeDuration::GKTimeDuration ( )

◆ GKTimeDuration() [2/3]

GKTimeDuration::GKTimeDuration ( int  h,
int  m,
int  s 
)

◆ GKTimeDuration() [3/3]

GKTimeDuration::GKTimeDuration ( const QTime &  qtime)

Member Function Documentation

◆ addMSecs()

GKTimeDuration GKTimeDuration::addMSecs ( int  ) const

Adds milliseconds to the current time duration

◆ addSecs()

GKTimeDuration GKTimeDuration::addSecs ( int  s) const

Adds seconds to the current time duration

◆ durationBetweenTimes()

static GKTimeDuration GKTimeDuration::durationBetweenTimes ( const QTime &  ,
const QTime &   
)
static

Duration between to times. Note that a duration is always positive so this function will reorder from and to if to < from.

◆ fromString()

static GKTimeDuration GKTimeDuration::fromString ( const QString &  )
static

Returns a duration from a string in the format HH:MM:SS

◆ hour()

uint GKTimeDuration::hour ( ) const

Convers this duration to hour, minutes, seconds and milliseconds and returns the hour. For example: 3610.5 is converted to 01:00:10.500 and it returns 1.

◆ isNull()

bool GKTimeDuration::isNull ( ) const

A duration of 0 milliseconds.

◆ isValid() [1/2]

bool GKTimeDuration::isValid ( ) const

Is valid?

◆ isValid() [2/2]

static bool GKTimeDuration::isValid ( int  ,
int  ,
int   
)
static

Is valid?

◆ minute()

uint GKTimeDuration::minute ( ) const

Convers this duration to hour, minutes, seconds and milliseconds and returns the minute. For example: 3610.5 is converted to 01:00:10.500 and it returns 0.

◆ msec()

uint GKTimeDuration::msec ( ) const

Convers this duration to hour, minutes, seconds and milliseconds and returns the millisecond. For example: 3610.5 is converted to 01:00:10.500 and it returns 500.

◆ msecsTo()

int GKTimeDuration::msecsTo ( const GKTimeDuration ) const

Returns the number of remaining milliseconds until the desired time)

◆ second()

uint GKTimeDuration::second ( ) const

Convers this duration to hour, minutes, seconds and milliseconds and returns the second. For example: 3610.5 is converted to 01:00:10.500 and it returns 10.

◆ secsTo()

int GKTimeDuration::secsTo ( const GKTimeDuration ) const

Returns the number of remaining seconds until the desired time)

◆ setHMS()

bool GKTimeDuration::setHMS ( int  h,
int  m,
int  s,
int  milliseconds = 0 
)

Set the duration.

◆ toDays()

uint GKTimeDuration::toDays ( uint *  milliseconds = NULL) const

Returns this duration in days, the remaining time is returned in milliseconds.

◆ toHours()

float GKTimeDuration::toHours ( ) const

Returns this GKTimeDuration's hour, minute and second converted to hours.

◆ toMilliseconds()

uint GKTimeDuration::toMilliseconds ( ) const

Get this duration in milliseconds (note that this is not equal to GKTimeDuration::msec)

◆ toMinutes()

float GKTimeDuration::toMinutes ( ) const

Returns this GKTimeDuration's hour, minute and second converted to minutes

◆ toQTime()

QTime GKTimeDuration::toQTime ( ) const

Retuns a QTime equivalent to this duration. Note that an overflow is possible as QTime only support 24 hours.

◆ toSeconds()

uint GKTimeDuration::toSeconds ( uint *  milliseconds = NULL) const

Returns this GKTimeDuration's hour, minute and second converted to seconds.

◆ toString()

QString GKTimeDuration::toString ( bool  forceMilliseconds = false) const

Returns a string representation of this duration. If forceMilliseconds is false it will not add millisecond info when they are zero.

© Aimsun SLU
Aimsun ®