Ort::Env Struct Reference

The Env (Environment) More...

#include <onnxruntime_cxx_api.h>

Inheritance diagram for Ort::Env:

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, _In_ 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, _In_ 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, _In_ const char *logid="")
	Wraps OrtApi::CreateEnvWithCustomLoggerAndGlobalThreadPools. More...
	Env (OrtEnv *p)
	C Interop Helper. More...
Env &	DisableTelemetryEvents ()
	Wraps OrtApi::EnableTelemetryEvents. More...
Env &	UpdateEnvWithCustomLogLevel (OrtLoggingLevel log_severity_level)
	Wraps OrtApi::UpdateEnvWithCustomLogLevel. More...
Env &	CreateAndRegisterAllocator (const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg)
	Wraps OrtApi::CreateAndRegisterAllocator. More...
Env &	CreateAndRegisterAllocatorV2 (const std::string &provider_type, const OrtMemoryInfo *mem_info, const std::unordered_map< std::string, std::string > &options, const OrtArenaCfg *arena_cfg)
	Wraps OrtApi::CreateAndRegisterAllocatorV2. More...
Public Member Functions inherited from Ort::detail::Base< OrtEnv >
constexpr	Base ()=default
constexpr	Base (contained_type *p) noexcept
	Base (const Base &)=delete
	Base (Base &&v) noexcept
	~Base ()
Base &	operator= (const Base &)=delete
Base &	operator= (Base &&v) noexcept
constexpr	operator contained_type * () const noexcept
contained_type *	release ()
	Relinquishes ownership of the contained C object pointer The underlying object is not destroyed. More...

Additional Inherited Members
Public Types inherited from Ort::detail::Base< OrtEnv >
using	contained_type = OrtEnv
Protected Attributes inherited from Ort::detail::Base< OrtEnv >
contained_type *	p_

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

Definition at line 697 of file onnxruntime_cxx_api.h.

Constructor & Destructor Documentation

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

inlineexplicit

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

Definition at line 698 of file onnxruntime_cxx_api.h.

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

inline

Wraps OrtApi::CreateEnv.

Definition at line 470 of file onnxruntime_cxx_inline.h.

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

inline

Wraps OrtApi::CreateEnvWithCustomLogger.

Definition at line 479 of file onnxruntime_cxx_inline.h.

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

inline

Wraps OrtApi::CreateEnvWithGlobalThreadPools.

Definition at line 488 of file onnxruntime_cxx_inline.h.

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

inline

Wraps OrtApi::CreateEnvWithCustomLoggerAndGlobalThreadPools.

Definition at line 497 of file onnxruntime_cxx_inline.h.

Ort::Env::Env ( OrtEnv *  p )

inlineexplicit

C Interop Helper.

Definition at line 714 of file onnxruntime_cxx_api.h.

Member Function Documentation

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

inline

Wraps OrtApi::CreateAndRegisterAllocator.

Definition at line 522 of file onnxruntime_cxx_inline.h.

Env & Ort::Env::CreateAndRegisterAllocatorV2 ( const std::string &  provider_type, const OrtMemoryInfo *  mem_info, const std::unordered_map< std::string, std::string > &  options, const OrtArenaCfg *  arena_cfg  )

inline

Wraps OrtApi::CreateAndRegisterAllocatorV2.

Definition at line 527 of file onnxruntime_cxx_inline.h.

Env & Ort::Env::DisableTelemetryEvents ( )

inline

Wraps OrtApi::EnableTelemetryEvents.

Wraps OrtApi::DisableTelemetryEvents

Definition at line 512 of file onnxruntime_cxx_inline.h.

Env & Ort::Env::UpdateEnvWithCustomLogLevel ( OrtLoggingLevel  log_severity_level )

inline

Wraps OrtApi::UpdateEnvWithCustomLogLevel.

Definition at line 517 of file onnxruntime_cxx_inline.h.

---

The documentation for this struct was generated from the following files:

• onnxruntime/core/session/onnxruntime_cxx_api.h
• onnxruntime/core/session/onnxruntime_cxx_inline.h