nvtx3::v1::mv2::scope_semantic Class Reference

Builder for the scope semantic applied to a payload entry. More...

#include <nvtx3.hpp>

Inheritance diagram for nvtx3::v1::mv2::scope_semantic:

Collaboration diagram for nvtx3::v1::mv2::scope_semantic:

Public Member Functions
	scope_semantic () noexcept
	Construct an unchained scope semantic.
	scope_semantic (nvtxSemanticsHeader_t const *next)
	Construct a scope semantic chained to another semantic header.
template<typename OtherDataType >
	scope_semantic (detail::semantic_base< OtherDataType > const &next)
	Construct a scope semantic that chains to another semantic builder.
scope_semantic &	scope (uint64_t scope_id) noexcept
	Set the scope by raw NVTX scope identifier.
scope_semantic &	scope (detail::scope_type s) noexcept
	Set the scope by nvtx3::scope identifier.

Detailed Description

Builder for the scope semantic applied to a payload entry.

Specifies the NVTX scope that applies to a particular value within a payload (for example, the scope of a counter or a timestamp). The scope must be known at schema registration time.

Definition at line 3919 of file nvtx3.hpp.

Constructor & Destructor Documentation

scope_semantic() [1/3]

nvtx3::v1::mv2::scope_semantic::scope_semantic ( )

inlinenoexcept

Construct an unchained scope semantic.

Definition at line 3924 of file nvtx3.hpp.

scope_semantic() [2/3]

nvtx3::v1::mv2::scope_semantic::scope_semantic ( nvtxSemanticsHeader_t const *  next )

inlineexplicit

Construct a scope semantic chained to another semantic header.

Parameters

next	Non-owning pointer to the next semantic in the chain, or nullptr.

Definition at line 3938 of file nvtx3.hpp.

scope_semantic() [3/3]

template<typename OtherDataType >

nvtx3::v1::mv2::scope_semantic::scope_semantic ( detail::semantic_base< OtherDataType > const &  next )

inlineexplicit

Construct a scope semantic that chains to another semantic builder.

Convenience overload of the header-pointer constructor that accepts a sibling semantic builder object directly. The referenced builder is copied into this object.

Template Parameters

OtherDataType

Underlying C struct type of the other semantic.

Parameters

next	The semantic builder to chain after this one.

Definition at line 3955 of file nvtx3.hpp.

Member Function Documentation

scope() [1/2]

scope_semantic & nvtx3::v1::mv2::scope_semantic::scope ( detail::scope_type  s )

inlinenoexcept

Set the scope by nvtx3::scope identifier.

Parameters

s	Scope identifier (wraps an NVTX_SCOPE_* value).

Returns

Reference to this object for chaining.

Definition at line 3977 of file nvtx3.hpp.

scope() [2/2]

scope_semantic & nvtx3::v1::mv2::scope_semantic::scope ( uint64_t  scope_id )

inlinenoexcept

Set the scope by raw NVTX scope identifier.

Parameters

scope_id

One of the NVTX_SCOPE_* values or a tool-defined scope.

Returns

Reference to this object for chaining.

Definition at line 3966 of file nvtx3.hpp.

---

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

• nvtx3.hpp