NVTX C++ API Reference 1.0
C++ convenience wrappers for NVTX v3 C API
Loading...
Searching...
No Matches
Public Member Functions | List of all members
nvtx3::v1::mv2::time_semantic Class Reference

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

#include <nvtx3.hpp>

Inheritance diagram for nvtx3::v1::mv2::time_semantic:
Inheritance graph
[legend]
Collaboration diagram for nvtx3::v1::mv2::time_semantic:
Collaboration graph
[legend]

Public Member Functions

 time_semantic () noexcept
 Construct an unchained time semantic.
 
 time_semantic (nvtxSemanticsHeader_t const *next)
 Construct a time semantic chained to another semantic header.
 
template<typename OtherDataType >
 time_semantic (detail::semantic_base< OtherDataType > const &next)
 Construct a time semantic that chains to another semantic builder.
 
time_semantictime_domain (uint64_t domain_id) noexcept
 Set the time domain by identifier.
 

Detailed Description

Builder for the time semantic applied to a payload entry.

Specifies the time domain of a timestamp payload entry. The domain is either a user-registered identifier or one of the predefined NVTX_TIMESTAMP_TYPE_* constants.

Definition at line 4065 of file nvtx3.hpp.

Constructor & Destructor Documentation

◆ time_semantic() [1/3]

nvtx3::v1::mv2::time_semantic::time_semantic ( )
inlinenoexcept

Construct an unchained time semantic.

Definition at line 4070 of file nvtx3.hpp.

◆ time_semantic() [2/3]

nvtx3::v1::mv2::time_semantic::time_semantic ( nvtxSemanticsHeader_t const *  next)
inlineexplicit

Construct a time semantic chained to another semantic header.

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

Definition at line 4084 of file nvtx3.hpp.

◆ time_semantic() [3/3]

template<typename OtherDataType >
nvtx3::v1::mv2::time_semantic::time_semantic ( detail::semantic_base< OtherDataType > const &  next)
inlineexplicit

Construct a time 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
OtherDataTypeUnderlying C struct type of the other semantic.
Parameters
nextThe semantic builder to chain after this one.

Definition at line 4101 of file nvtx3.hpp.

Member Function Documentation

◆ time_domain()

time_semantic & nvtx3::v1::mv2::time_semantic::time_domain ( uint64_t  domain_id)
inlinenoexcept

Set the time domain by identifier.

Parameters
domain_idA tool-registered time domain ID or a predefined NVTX_TIMESTAMP_TYPE_* value.
Returns
Reference to this object for chaining.

Definition at line 4113 of file nvtx3.hpp.


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