IStats#

class omni.stats.IStats#

Bases: pybind11_object

Methods

__init__(*args, **kwargs)

get_scope_count(self)

Get the number of the scopes.

get_scopes(self)

Get the scope nodes as tuple of dictionaries, which contains the information of all the scopes.

get_stats(self, scopeId)

Get the stat nodes as tuple of dictionaries, which contains the information of all the stats within the specified scope.

get_stats_count(self, scopeId)

Get the number of the stats within the specified scope at the root level, excluding the nested children stats.

get_stats_nested(self, scopeId[, ...])

Get all the stat nodes including nested ones as flattened tuple of dictionaries, which contains the information of all the stats within the specified scope.

get_total_stats_count(self, scopeId)

Get the total number of the stats within the specified scope, including all the nested children stats.
__init__(*args, **kwargs)#
get_scope_count(self: omni.stats._stats.IStats) → int#

Get the number of the scopes.

get_scopes(self: omni.stats._stats.IStats) → tuple#

Get the scope nodes as tuple of dictionaries, which contains the information of all the scopes.

get_stats(
self: omni.stats._stats.IStats,
scopeId: capsule,
) → tuple#

Get the stat nodes as tuple of dictionaries, which contains the information of all the stats within the specified scope.

get_stats_count(
self: omni.stats._stats.IStats,
scopeId: capsule,
) → int#

Get the number of the stats within the specified scope at the root level, excluding the nested children stats.

get_stats_nested(
self: omni.stats._stats.IStats,
scopeId: capsule,
sort_by_description: bool = False,
sort_reversed: bool = False,
) → tuple#

Get all the stat nodes including nested ones as flattened tuple of dictionaries, which contains the information of all the stats within the specified scope. Tuples are ordered with the nested nodes directly below them with a non-zero level value, based on depth-first search (DPS) traversal output. Once a level value reaches zero for a stat, a new top level stat node has started following with nested nodes again. The returned tuples and their levels (L#) will be in below order, flattened: e.g. [S0 (L0), S1 (L1), S2 (L2), S3 (L0), S4 (L1)]

Parameters:

  • scopeId – The Scope identifier to get stats nodes from.

  • sort_by_description – sort stats nodes by the description in ascending order.

  • sort_reversed – reverse the order of sorting to be in descending order.

get_total_stats_count(
self: omni.stats._stats.IStats,
scopeId: capsule,
) → int#

Get the total number of the stats within the specified scope, including all the nested children stats.

Parameters:

scopeId – The Scope identifier to get stats nodes from.