8.8.1.1.2.2.5. Clock

class Clock

disable() → None

Disable the profile clock.

session.clock.disable()

Return type:

None

disableAutoReset() → None

Disable Auto-Reset mode for the profile clock.

session.clock.disableAutoReset()

Return type:

None

enable() → None

Enable the profile clock.

session.clock.enable()

Return type:

None

enableAutoReset() → None

Enable Auto-Reset mode for the profile clock.

session.clock.enableAutoReset()

Return type:

None

getCurrentEvent() → ClockEvent | None

Get the currently configured profile clock event.

event = session.clock.getCurrentEvent()
if event:
    print(f"The clock is currently profiling {event.name}")
else:
    print("The clock is not currently profiling an event")

Returns:

The currently configured profile clock event.

Return type:

ClockEvent | None

getEvents() → list[ClockEvent]

Get a list of all available profile clock events.

events = session.clock.getEvents()
for event in events:
    print(f"{event['id']}: {event['name']}")

Returns:

A list of all available profile clock events.

Return type:

list[ClockEvent]

read() → int | str

Read the current value of the profile clock counter.

count = session.clock.read()

Returns:

The current value of the profile clock.

Return type:

int | str

reset() → None

Reset the profile clock counter to zero.

session.clock.reset()

Return type:

None

setCurrentEvent(event) → None

Configure the profile clock to profile/count a particular event.

# by id
session.clock.setCurrentEvent( 1 )
# by name (this is just an example, events differ by target)
session.clock.setCurrentEvent("CPU.discontinuity.branch")

Parameters:

event (int | str) -- The id or name of the event to profile.

Return type:

None