OnnxRuntime
Ort::Env Struct Reference

The Env (Environment) More...

#include <onnxruntime_cxx_api.h>

Inherits Ort::Base< OrtEnv >.

Public Member Functions

 Env (std::nullptr_t)
 Create an empty Env object, must be assigned a valid one to be used. More...
 
 Env (OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
 Wraps OrtApi::CreateEnv. More...
 
 Env (OrtLoggingLevel logging_level, const char *logid, OrtLoggingFunction logging_function, void *logger_param)
 Wraps OrtApi::CreateEnvWithCustomLogger. More...
 
 Env (const OrtThreadingOptions *tp_options, OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
 Wraps OrtApi::CreateEnvWithGlobalThreadPools. More...
 
 Env (const OrtThreadingOptions *tp_options, OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
 Wraps OrtApi::CreateEnvWithCustomLoggerAndGlobalThreadPools. More...
 
 Env (OrtEnv *p)
 C Interop Helper. More...
 
EnvEnableTelemetryEvents ()
 Wraps OrtApi::EnableTelemetryEvents. More...
 
EnvDisableTelemetryEvents ()
 Wraps OrtApi::DisableTelemetryEvents. More...
 
EnvCreateAndRegisterAllocator (const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg)
 Wraps OrtApi::CreateAndRegisterAllocator. More...
 
- Public Member Functions inherited from Ort::Base< OrtEnv >
 Base ()=default
 
 Base (OrtEnv *p)
 
 ~Base ()
 
 operator OrtEnv * ()
 
 operator const OrtEnv * () const
 
OrtEnvrelease ()
 Releases ownership of the contained pointer. More...
 

Additional Inherited Members

- Public Types inherited from Ort::Base< OrtEnv >
using contained_type = OrtEnv
 
- Protected Member Functions inherited from Ort::Base< OrtEnv >
 Base (const Base &)=delete
 
 Base (Base &&v) noexcept
 
Baseoperator= (const Base &)=delete
 
void operator= (Base &&v) noexcept
 
- Protected Attributes inherited from Ort::Base< OrtEnv >
OrtEnvp_
 

Detailed Description

The Env (Environment)

The Env holds the logging state used by all other objects. Note: One Env must be created before using any other Onnxruntime functionality

Constructor & Destructor Documentation

◆ Env() [1/6]

Ort::Env::Env ( std::nullptr_t  )
inlineexplicit

Create an empty Env object, must be assigned a valid one to be used.

◆ Env() [2/6]

Ort::Env::Env ( OrtLoggingLevel  logging_level = ORT_LOGGING_LEVEL_WARNING,
const char *  logid = "" 
)

◆ Env() [3/6]

Ort::Env::Env ( OrtLoggingLevel  logging_level,
const char *  logid,
OrtLoggingFunction  logging_function,
void *  logger_param 
)

◆ Env() [4/6]

Ort::Env::Env ( const OrtThreadingOptions tp_options,
OrtLoggingLevel  logging_level = ORT_LOGGING_LEVEL_WARNING,
const char *  logid = "" 
)

◆ Env() [5/6]

Ort::Env::Env ( const OrtThreadingOptions tp_options,
OrtLoggingFunction  logging_function,
void *  logger_param,
OrtLoggingLevel  logging_level = ORT_LOGGING_LEVEL_WARNING,
const char *  logid = "" 
)

◆ Env() [6/6]

Ort::Env::Env ( OrtEnv p)
inlineexplicit

C Interop Helper.

Member Function Documentation

◆ CreateAndRegisterAllocator()

Env & Ort::Env::CreateAndRegisterAllocator ( const OrtMemoryInfo mem_info,
const OrtArenaCfg arena_cfg 
)

◆ DisableTelemetryEvents()

Env & Ort::Env::DisableTelemetryEvents ( )

◆ EnableTelemetryEvents()

Env & Ort::Env::EnableTelemetryEvents ( )