NVIDIA DeepStream SDK API Reference

9.2 Release
sdk::instrumentationscope::InstrumentationScope Class Reference

Detailed Description

Public Member Functions

 InstrumentationScope (const InstrumentationScope &)=default
 
std::size_t HashCode () const noexcept
 
bool operator== (const InstrumentationScope &other) const noexcept
 Compare 2 instrumentation libraries. More...
 
bool equal (const nostd::string_view name, const nostd::string_view version, const nostd::string_view schema_url="", const opentelemetry::common::KeyValueIterable *attributes=nullptr) const noexcept
 Check whether the instrumentation scope has given name and version. More...
 
const std::string & GetName () const noexcept
 
const std::string & GetVersion () const noexcept
 
const std::string & GetSchemaURL () const noexcept
 
const InstrumentationScopeAttributes & GetAttributes () const noexcept
 
void SetAttribute (nostd::string_view key, const opentelemetry::common::AttributeValue &value) noexcept
 
 InstrumentationScope (const InstrumentationScope &)=default
 
std::size_t HashCode () const noexcept
 
bool operator== (const InstrumentationScope &other) const noexcept
 Compare 2 instrumentation libraries. More...
 
bool equal (const nostd::string_view name, const nostd::string_view version, const nostd::string_view schema_url="", const opentelemetry::common::KeyValueIterable *attributes=nullptr) const noexcept
 Check whether the instrumentation scope has given name and version. More...
 
const std::string & GetName () const noexcept
 
const std::string & GetVersion () const noexcept
 
const std::string & GetSchemaURL () const noexcept
 
const InstrumentationScopeAttributes & GetAttributes () const noexcept
 
void SetAttribute (nostd::string_view key, const opentelemetry::common::AttributeValue &value) noexcept
 

Static Public Member Functions

static nostd::unique_ptr< InstrumentationScope > Create (nostd::string_view name, nostd::string_view version="", nostd::string_view schema_url="", InstrumentationScopeAttributes &&attributes={})
 Returns a newly created InstrumentationScope with the specified library name and version. More...
 
static nostd::unique_ptr< InstrumentationScope > Create (nostd::string_view name, nostd::string_view version, nostd::string_view schema_url, const InstrumentationScopeAttributes &attributes)
 Returns a newly created InstrumentationScope with the specified library name and version. More...
 
template<class ArgumentType , nostd::enable_if_t< opentelemetry::common::detail::is_key_value_iterable< ArgumentType >::value > * = nullptr>
static nostd::unique_ptr< InstrumentationScope > Create (nostd::string_view name, nostd::string_view version, nostd::string_view schema_url, const ArgumentType &arg)
 Returns a newly created InstrumentationScope with the specified library name and version. More...
 
static nostd::unique_ptr< InstrumentationScope > Create (nostd::string_view name, nostd::string_view version="", nostd::string_view schema_url="", InstrumentationScopeAttributes &&attributes={})
 Returns a newly created InstrumentationScope with the specified library name and version. More...
 
static nostd::unique_ptr< InstrumentationScope > Create (nostd::string_view name, nostd::string_view version, nostd::string_view schema_url, const InstrumentationScopeAttributes &attributes)
 Returns a newly created InstrumentationScope with the specified library name and version. More...
 
template<class ArgumentType , nostd::enable_if_t< opentelemetry::common::detail::is_key_value_iterable< ArgumentType >::value > * = nullptr>
static nostd::unique_ptr< InstrumentationScope > Create (nostd::string_view name, nostd::string_view version, nostd::string_view schema_url, const ArgumentType &arg)
 Returns a newly created InstrumentationScope with the specified library name and version. More...
 

Constructor & Destructor Documentation

◆ InstrumentationScope() [1/2]

sdk::instrumentationscope::InstrumentationScope::InstrumentationScope ( const InstrumentationScope &  )
default

◆ InstrumentationScope() [2/2]

sdk::instrumentationscope::InstrumentationScope::InstrumentationScope ( const InstrumentationScope &  )
default

Member Function Documentation

◆ Create() [1/6]

template<class ArgumentType , nostd::enable_if_t< opentelemetry::common::detail::is_key_value_iterable< ArgumentType >::value > * = nullptr>
static nostd::unique_ptr<InstrumentationScope> sdk::instrumentationscope::InstrumentationScope::Create ( nostd::string_view  name,
nostd::string_view  version,
nostd::string_view  schema_url,
const ArgumentType &  arg 
)
inlinestatic

Returns a newly created InstrumentationScope with the specified library name and version.

Parameters
namename of the instrumentation scope.
versionversion of the instrumentation scope.
schema_urlschema url of the telemetry emitted by the library.
argarguments used to create attributes of the instrumentation scope.
Returns
the newly created InstrumentationScope.

Definition at line 79 of file includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h.

References pydeepstreamdoc::tensor::TensorDoc::size, and version.

◆ Create() [2/6]

template<class ArgumentType , nostd::enable_if_t< opentelemetry::common::detail::is_key_value_iterable< ArgumentType >::value > * = nullptr>
static nostd::unique_ptr<InstrumentationScope> sdk::instrumentationscope::InstrumentationScope::Create ( nostd::string_view  name,
nostd::string_view  version,
nostd::string_view  schema_url,
const ArgumentType &  arg 
)
inlinestatic

Returns a newly created InstrumentationScope with the specified library name and version.

Parameters
namename of the instrumentation scope.
versionversion of the instrumentation scope.
schema_urlschema url of the telemetry emitted by the library.
argarguments used to create attributes of the instrumentation scope.
Returns
the newly created InstrumentationScope.

Definition at line 79 of file 9.2/includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h.

References pydeepstreamdoc::tensor::TensorDoc::size, and version.

◆ Create() [3/6]

static nostd::unique_ptr<InstrumentationScope> sdk::instrumentationscope::InstrumentationScope::Create ( nostd::string_view  name,
nostd::string_view  version,
nostd::string_view  schema_url,
const InstrumentationScopeAttributes &  attributes 
)
inlinestatic

Returns a newly created InstrumentationScope with the specified library name and version.

Parameters
namename of the instrumentation scope.
versionversion of the instrumentation scope.
schema_urlschema url of the telemetry emitted by the library.
attributesattributes of the instrumentation scope.
Returns
the newly created InstrumentationScope.

Definition at line 57 of file 9.2/includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h.

References version.

◆ Create() [4/6]

static nostd::unique_ptr<InstrumentationScope> sdk::instrumentationscope::InstrumentationScope::Create ( nostd::string_view  name,
nostd::string_view  version,
nostd::string_view  schema_url,
const InstrumentationScopeAttributes &  attributes 
)
inlinestatic

Returns a newly created InstrumentationScope with the specified library name and version.

Parameters
namename of the instrumentation scope.
versionversion of the instrumentation scope.
schema_urlschema url of the telemetry emitted by the library.
attributesattributes of the instrumentation scope.
Returns
the newly created InstrumentationScope.

Definition at line 57 of file includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h.

References version.

◆ Create() [5/6]

static nostd::unique_ptr<InstrumentationScope> sdk::instrumentationscope::InstrumentationScope::Create ( nostd::string_view  name,
nostd::string_view  version = "",
nostd::string_view  schema_url = "",
InstrumentationScopeAttributes &&  attributes = {} 
)
inlinestatic

Returns a newly created InstrumentationScope with the specified library name and version.

Parameters
namename of the instrumentation scope.
versionversion of the instrumentation scope.
schema_urlschema url of the telemetry emitted by the library.
attributesattributes of the instrumentation scope.
Returns
the newly created InstrumentationScope.

Definition at line 39 of file includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h.

◆ Create() [6/6]

static nostd::unique_ptr<InstrumentationScope> sdk::instrumentationscope::InstrumentationScope::Create ( nostd::string_view  name,
nostd::string_view  version = "",
nostd::string_view  schema_url = "",
InstrumentationScopeAttributes &&  attributes = {} 
)
inlinestatic

Returns a newly created InstrumentationScope with the specified library name and version.

Parameters
namename of the instrumentation scope.
versionversion of the instrumentation scope.
schema_urlschema url of the telemetry emitted by the library.
attributesattributes of the instrumentation scope.
Returns
the newly created InstrumentationScope.

Definition at line 39 of file 9.2/includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h.

◆ equal() [1/2]

bool sdk::instrumentationscope::InstrumentationScope::equal ( const nostd::string_view  name,
const nostd::string_view  version,
const nostd::string_view  schema_url = "",
const opentelemetry::common::KeyValueIterable *  attributes = nullptr 
) const
inlinenoexcept

Check whether the instrumentation scope has given name and version.

This could be used to check version equality and avoid heap allocation.

Parameters
namename of the instrumentation scope to compare.
versionversion of the instrumentation scope to compare.
schema_urlschema url of the telemetry emitted by the scope.
attributesattributes of the instrumentation scope to compare.
Returns
true if name and version in this instrumentation scope are equal with the given name and version.

Definition at line 120 of file 9.2/includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h.

References version.

◆ equal() [2/2]

bool sdk::instrumentationscope::InstrumentationScope::equal ( const nostd::string_view  name,
const nostd::string_view  version,
const nostd::string_view  schema_url = "",
const opentelemetry::common::KeyValueIterable *  attributes = nullptr 
) const
inlinenoexcept

Check whether the instrumentation scope has given name and version.

This could be used to check version equality and avoid heap allocation.

Parameters
namename of the instrumentation scope to compare.
versionversion of the instrumentation scope to compare.
schema_urlschema url of the telemetry emitted by the scope.
attributesattributes of the instrumentation scope to compare.
Returns
true if name and version in this instrumentation scope are equal with the given name and version.

Definition at line 120 of file includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h.

References version.

◆ GetAttributes() [1/2]

const InstrumentationScopeAttributes& sdk::instrumentationscope::InstrumentationScope::GetAttributes ( ) const
inlinenoexcept

◆ GetAttributes() [2/2]

const InstrumentationScopeAttributes& sdk::instrumentationscope::InstrumentationScope::GetAttributes ( ) const
inlinenoexcept

◆ GetName() [1/2]

const std::string& sdk::instrumentationscope::InstrumentationScope::GetName ( ) const
inlinenoexcept

◆ GetName() [2/2]

const std::string& sdk::instrumentationscope::InstrumentationScope::GetName ( ) const
inlinenoexcept

◆ GetSchemaURL() [1/2]

const std::string& sdk::instrumentationscope::InstrumentationScope::GetSchemaURL ( ) const
inlinenoexcept

◆ GetSchemaURL() [2/2]

const std::string& sdk::instrumentationscope::InstrumentationScope::GetSchemaURL ( ) const
inlinenoexcept

◆ GetVersion() [1/2]

const std::string& sdk::instrumentationscope::InstrumentationScope::GetVersion ( ) const
inlinenoexcept

◆ GetVersion() [2/2]

const std::string& sdk::instrumentationscope::InstrumentationScope::GetVersion ( ) const
inlinenoexcept

◆ HashCode() [1/2]

std::size_t sdk::instrumentationscope::InstrumentationScope::HashCode ( ) const
inlinenoexcept

◆ HashCode() [2/2]

std::size_t sdk::instrumentationscope::InstrumentationScope::HashCode ( ) const
inlinenoexcept

◆ operator==() [1/2]

bool sdk::instrumentationscope::InstrumentationScope::operator== ( const InstrumentationScope &  other) const
inlinenoexcept

Compare 2 instrumentation libraries.

Parameters
otherthe instrumentation scope to compare to.
Returns
true if the 2 instrumentation libraries are equal, false otherwise.

Definition at line 104 of file includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h.

◆ operator==() [2/2]

bool sdk::instrumentationscope::InstrumentationScope::operator== ( const InstrumentationScope &  other) const
inlinenoexcept

Compare 2 instrumentation libraries.

Parameters
otherthe instrumentation scope to compare to.
Returns
true if the 2 instrumentation libraries are equal, false otherwise.

Definition at line 104 of file 9.2/includes/opentelemetry/sdk/instrumentationscope/instrumentation_scope.h.

◆ SetAttribute() [1/2]

void sdk::instrumentationscope::InstrumentationScope::SetAttribute ( nostd::string_view  key,
const opentelemetry::common::AttributeValue &  value 
)
inlinenoexcept

◆ SetAttribute() [2/2]

void sdk::instrumentationscope::InstrumentationScope::SetAttribute ( nostd::string_view  key,
const opentelemetry::common::AttributeValue &  value 
)
inlinenoexcept

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