com.xilinx.rapidwright.util

Class RuntimeTracker

Object

com.xilinx.rapidwright.util.RuntimeTracker

public class RuntimeTracker
extends Object

A customized RuntimeTracker class, providing start and stop methods for recording total elapsed time of a process. Each RuntimeTracker Object should be created at least with a name. It also supports a user case of RuntimeTrackerTree instance for runtime analysis of an entire program.

Constructor Summary

Constructors

Constructor and Description
RuntimeTracker(String name)
RuntimeTracker(String name, short level)

Method Summary

Modifier and Type	Method and Description
void	addChild(RuntimeTracker runtimeTracker) Adds a child runtime tracker.
List<RuntimeTracker>	getChildren() Gets the child runtime trackers.
short	getLevel() Gets the level of a RuntimeTracker instance.
String	getName() Gets the runtime tracker name.
long	getTime() Gets the total time elapsed in nanoseconds.
int	hashCode()
void	setLevel(short level) Sets the level (depth) of a RuntimeTracker instance if it is included in a tree.
void	setTime(long time) Sets the total time.
void	start()
void	stop() Stops the runtime tracker and stores the total time elapsed in nanoseconds.
String	toString()
String	trackerWithOneLevelChidren() Returns a string representing a runtime tracker and its child trackers.
String	trakerWithFullHierarchy() Returns a string that represents the full hierarchy of a runtime tracker, including all the downhill runtime trackers to the leaf runtime trackers.

Methods inherited from class Object

equals, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RuntimeTracker

public RuntimeTracker(String name)

RuntimeTracker

public RuntimeTracker(String name,
                      short level)

Method Detail

getLevel

public short getLevel()

Gets the level of a RuntimeTracker instance.

Returns:

setLevel

public void setLevel(short level)

Sets the level (depth) of a RuntimeTracker instance if it is included in a tree.

Parameters:

level -

getChildren

public List<RuntimeTracker> getChildren()

Gets the child runtime trackers.

Returns:

addChild

public void addChild(RuntimeTracker runtimeTracker)

Adds a child runtime tracker.

Parameters:

runtimeTracker - The child runtime tracker.

start

public void start()

stop

public void stop()

Stops the runtime tracker and stores the total time elapsed in nanoseconds.

setTime

public void setTime(long time)

Sets the total time.

Parameters:

time -

getTime

public long getTime()

Gets the total time elapsed in nanoseconds.

Returns:

The total time elapsed in nanoseconds.

getName

public String getName()

Gets the runtime tracker name.

Returns:

The runtime tracker name.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

trakerWithFullHierarchy

public String trakerWithFullHierarchy()

Returns a string that represents the full hierarchy of a runtime tracker, including all the downhill runtime trackers to the leaf runtime trackers.

Returns:

trackerWithOneLevelChidren

public String trackerWithOneLevelChidren()

Returns a string representing a runtime tracker and its child trackers.

Returns: