nvtx3::v1::mv2::correlation_semantic Class Reference

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

#include <nvtx3.hpp>

Inheritance diagram for nvtx3::v1::mv2::correlation_semantic:

Collaboration diagram for nvtx3::v1::mv2::correlation_semantic:

Public Member Functions
	correlation_semantic () noexcept
	Construct an unchained correlation semantic.
	correlation_semantic (nvtxSemanticsHeader_t const *next)
	Construct a correlation semantic chained to another semantic header.
template<typename OtherDataType >
	correlation_semantic (detail::semantic_base< OtherDataType > const &next)
	Construct a correlation semantic that chains to another semantic builder.
correlation_semantic &	domain_uuid (const unsigned char uuid[16]) noexcept
	Set the correlation domain UUID.
correlation_semantic &	display_name (const char *name) noexcept
	Set the optional display name for the correlation domain.
correlation_semantic &	display_name (std::string const &name) noexcept
	Set the optional display name for the correlation domain.
correlation_semantic &	display_name (std::string &&name)=delete
	Disallow setting the borrowed display name from a temporary string.
correlation_semantic &	role (uint64_t role_id) noexcept
	Set the role this entry plays in the correlation.

Detailed Description

Builder for the correlation semantic applied to a payload entry.

Marks an entry as the identifier of a correlation domain and specifies how the event relates to other events in that domain. The UUID must be globally unique across NVTX domains; the optional display name is copied by the tool at schema registration time.

Definition at line 4317 of file nvtx3.hpp.

Constructor & Destructor Documentation

correlation_semantic() [1/3]

nvtx3::v1::mv2::correlation_semantic::correlation_semantic ( )

inlinenoexcept

Construct an unchained correlation semantic.

Definition at line 4322 of file nvtx3.hpp.

correlation_semantic() [2/3]

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

inlineexplicit

Construct a correlation semantic chained to another semantic header.

Parameters

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

Definition at line 4338 of file nvtx3.hpp.

correlation_semantic() [3/3]

template<typename OtherDataType >

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

inlineexplicit

Construct a correlation 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 4355 of file nvtx3.hpp.

Member Function Documentation

display_name() [1/2]

correlation_semantic & nvtx3::v1::mv2::correlation_semantic::display_name ( const char *  name )

inlinenoexcept

Set the optional display name for the correlation domain.

Parameters

name	String copied by the tool at schema registration; must remain valid until then.

Returns

Reference to this object for chaining.

Definition at line 4380 of file nvtx3.hpp.

display_name() [2/2]

correlation_semantic & nvtx3::v1::mv2::correlation_semantic::display_name ( std::string const &  name )

inlinenoexcept

Set the optional display name for the correlation domain.

Parameters

name	String copied by the tool at schema registration; must remain valid until then.

Returns

Reference to this object for chaining.

Definition at line 4392 of file nvtx3.hpp.

domain_uuid()

correlation_semantic & nvtx3::v1::mv2::correlation_semantic::domain_uuid ( const unsigned char  uuid[16] )

inlinenoexcept

Set the correlation domain UUID.

Parameters

uuid	A 16-byte array that must be globally unique across NVTX domains.

Returns

Reference to this object for chaining.

Definition at line 4366 of file nvtx3.hpp.

role()

correlation_semantic & nvtx3::v1::mv2::correlation_semantic::role ( uint64_t  role_id )

inlinenoexcept

Set the role this entry plays in the correlation.

Parameters

role_id

One of the NVTX_CORRELATION_ROLE_* values.

Returns

Reference to this object for chaining.

Definition at line 4407 of file nvtx3.hpp.

---

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

• nvtx3.hpp