Drag[en]gine Script Module DragonScript Script API  1.0
RuntimeMeter Class Reference

Runtime meter. More...

Inheritance diagram for RuntimeMeter:

Public Member Functions

Constructors
RuntimeMeter new ()
 Create runtime meter. More...
 
Management
void reset (int meter)
 Reset meter by 0-based index. More...
 
void reset (int meterFirst, int meterCount)
 Reset range of meters by 0-based index. More...
 
float elapsed (int meter)
 Elapsed time in seconds for meter. More...
 
int elapsedMicroSec (int meter)
 Elapsed time in micro-seconds for meter. More...
 
void counterReset (int counter)
 Reset counter. More...
 
void counterReset (int counterFirst, int counterCount)
 Reset range of counters. More...
 
void counterAdd (int meter, int counter)
 Add elapsed time in micro-seconds off meter to a counter. More...
 
int counterTime (int counter)
 Accumulated time in a counter in micro-seconds. More...
 
int counterUpdates (int counter)
 Number of times a counter has been incremented. More...
 
int counterAverageTime (int counter)
 Average time per update from a counter. More...
 

Detailed Description

Runtime meter.

Support for time consumption testing for debugging purpose.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ counterAdd()

void counterAdd ( int  meter,
int  counter 
)

Add elapsed time in micro-seconds off meter to a counter.

Resets the meter to 0 afterwards.

§ counterAverageTime()

int counterAverageTime ( int  counter)

Average time per update from a counter.

If no updates have been done 0 is returned.

§ counterReset() [1/2]

void counterReset ( int  counter)

Reset counter.

If not used yet the counter is created.

§ counterReset() [2/2]

void counterReset ( int  counterFirst,
int  counterCount 
)

Reset range of counters.

If not used yet the counters are created.

§ counterTime()

int counterTime ( int  counter)

Accumulated time in a counter in micro-seconds.

§ counterUpdates()

int counterUpdates ( int  counter)

Number of times a counter has been incremented.

§ elapsed()

float elapsed ( int  meter)

Elapsed time in seconds for meter.

Resets the meter to 0 after returning.

§ elapsedMicroSec()

int elapsedMicroSec ( int  meter)

Elapsed time in micro-seconds for meter.

Resets the meter to 0 after returning.

§ new()

RuntimeMeter new ( )

Create runtime meter.

§ reset() [1/2]

void reset ( int  meter)

Reset meter by 0-based index.

If not used yet the meter is created.

§ reset() [2/2]

void reset ( int  meterFirst,
int  meterCount 
)

Reset range of meters by 0-based index.

If not used yet the meters are created.


The documentation for this class was generated from the following file: