Zone#

Fully qualified name: isaacsim::common::profiling::Zone

class Zone#

Movable RAII ownership for one admitted CPU zone.

Public Functions

Zone() noexcept = default#
Zone(
std::string_view name,
Mask mask = 0,
SourceLocation location = makeSourceLocation(),
) noexcept#

Begin a CPU zone if the attached profiler admits the selected mask.

Parameters:
  • name – [in] Profiler-visible zone name.

  • mask – [in] Carbonite capture mask. Zero selects the default mask.

  • location – [in] Source metadata for the zone.

~Zone() noexcept#
Zone(Zone &&other) noexcept#

Transfer ownership of an active zone.

Parameters:

other – [inout] Zone to move from. It is inactive after the transfer.

Zone &operator=(Zone &&other) noexcept#

End the current zone and transfer ownership from another zone.

Parameters:

other – [inout] Zone to move from. It is inactive after the transfer.

Returns:

Reference to this zone.

Zone(const Zone&) = delete#
Zone &operator=(const Zone&) = delete#
void close() noexcept#

End the zone if it is active.

Repeated calls are harmless.

explicit operator bool() const noexcept#

Return whether a Carbonite profiler admitted this zone.

Public Static Functions

template<typename NameFactory>
static inline Zone lazy(
NameFactory &&nameFactory,
Mask mask = 0,
SourceLocation location = makeSourceLocation(),
) noexcept#

Create a zone without evaluating the name factory when profiling is disabled.