rootsim_stats.RSStats Class Reference

The statistics class used to load and pre-process ROOT-Sim statistics files. More...

Public Member Functions
def	__init__ (self, rs_stats_file)
	Construct a new RSStats object. More...
def	gvts (self)
	Get the GVT values. More...
def	rts (self, reduction=min)
	Get the real time values. More...
def	metrics (self)
	Get the thread-specific metric names. More...
def	nodes_stats (self)
	Get the node-specific statistics. More...
def	nodes_count (self)
def	thread_metric_get (self, metric, aggregate_gvts=False, aggregate_threads=False, aggregate_nodes=False)
	Get the thread-specific metric values. More...

Public Attributes
	all_stats
	big_endian
	threads_count

Detailed Description

The statistics class used to load and pre-process ROOT-Sim statistics files.

If you configured ROOT-Sim to produce a statistics file, a binary file will be generated. You can use the facilities offered by this class to efficiently load those statistics.

Constructor & Destructor Documentation

__init__()

def rootsim_stats.RSStats.__init__	(		self,
			rs_stats_file
	)

Construct a new RSStats object.

Parameters

self	the RSStats instance being constructed
rs_stats_file	the path of the binary statistics file generated by ROOT-Sim

Member Function Documentation

gvts()

def rootsim_stats.RSStats.gvts

(

self

)

Get the GVT values.

Returns

a list containing the computed GVTs (Global Virtual Times) in ascending order

metrics()

def rootsim_stats.RSStats.metrics

(

self

)

Get the thread-specific metric names.

Returns

a list containing the metric names that you can use in thread_metric_get()

nodes_stats()

def rootsim_stats.RSStats.nodes_stats

(

self

)

Get the node-specific statistics.

Returns

a dictionary containing node-specific statistics TODO more thorough description of what we have here

rts()

def rootsim_stats.RSStats.rts	(		self,
			reduction = min
	)

Get the real time values.

Returns

a list containing the computed real times in ascending order

thread_metric_get()

def rootsim_stats.RSStats.thread_metric_get	(		self,
			metric,
			aggregate_gvts = False,
			aggregate_threads = False,
			aggregate_nodes = False
	)

Get the thread-specific metric values.

Returns

a list of values FIXME: much more complicated, explain it! TODO: optionally provide stats normalized by real-time

---

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

• /home/runner/work/core/core/src/log/parse/rootsim_stats.py