Ort::RunOptions Struct Reference

RunOptions. More...

#include <onnxruntime_cxx_api.h>

Inheritance diagram for Ort::RunOptions:

Public Member Functions
	RunOptions (std::nullptr_t)
	Create an empty RunOptions object, must be assigned a valid one to be used. More...
	RunOptions ()
	Wraps OrtApi::CreateRunOptions. More...
RunOptions &	SetRunLogVerbosityLevel (int)
	Wraps OrtApi::RunOptionsSetRunLogVerbosityLevel. More...
int	GetRunLogVerbosityLevel () const
	Wraps OrtApi::RunOptionsGetRunLogVerbosityLevel. More...
RunOptions &	SetRunLogSeverityLevel (int)
	Wraps OrtApi::RunOptionsSetRunLogSeverityLevel. More...
int	GetRunLogSeverityLevel () const
	Wraps OrtApi::RunOptionsGetRunLogSeverityLevel. More...
RunOptions &	SetRunTag (const char *run_tag)
	wraps OrtApi::RunOptionsSetRunTag More...
const char *	GetRunTag () const
	Wraps OrtApi::RunOptionsGetRunTag. More...
RunOptions &	AddConfigEntry (const char *config_key, const char *config_value)
	Wraps OrtApi::AddRunConfigEntry. More...
RunOptions &	SetTerminate ()
	Terminates all currently executing Session::Run calls that were made using this RunOptions instance. More...
RunOptions &	UnsetTerminate ()
	Clears the terminate flag so this RunOptions instance can be used in a new Session::Run call without it instantly terminating. More...
Public Member Functions inherited from Ort::detail::Base< OrtRunOptions >
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< OrtRunOptions >
using	contained_type = OrtRunOptions
Protected Attributes inherited from Ort::detail::Base< OrtRunOptions >
contained_type *	p_

Detailed Description

RunOptions.

Definition at line 438 of file onnxruntime_cxx_api.h.

Constructor & Destructor Documentation

Ort::RunOptions::RunOptions ( std::nullptr_t  )

inlineexplicit

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

Definition at line 439 of file onnxruntime_cxx_api.h.

Ort::RunOptions::RunOptions ( )

inline

Wraps OrtApi::CreateRunOptions.

Definition at line 475 of file onnxruntime_cxx_inline.h.

Member Function Documentation

RunOptions & Ort::RunOptions::AddConfigEntry ( const char *  config_key, const char *  config_value  )

inline

Wraps OrtApi::AddRunConfigEntry.

Definition at line 512 of file onnxruntime_cxx_inline.h.

int Ort::RunOptions::GetRunLogSeverityLevel ( ) const

inline

Wraps OrtApi::RunOptionsGetRunLogSeverityLevel.

Definition at line 495 of file onnxruntime_cxx_inline.h.

int Ort::RunOptions::GetRunLogVerbosityLevel ( ) const

inline

Wraps OrtApi::RunOptionsGetRunLogVerbosityLevel.

Definition at line 489 of file onnxruntime_cxx_inline.h.

const char * Ort::RunOptions::GetRunTag ( ) const

inline

Wraps OrtApi::RunOptionsGetRunTag.

Definition at line 506 of file onnxruntime_cxx_inline.h.

RunOptions & Ort::RunOptions::SetRunLogSeverityLevel ( int  level )

inline

Wraps OrtApi::RunOptionsSetRunLogSeverityLevel.

Definition at line 484 of file onnxruntime_cxx_inline.h.

RunOptions & Ort::RunOptions::SetRunLogVerbosityLevel ( int  level )

inline

Wraps OrtApi::RunOptionsSetRunLogVerbosityLevel.

Definition at line 479 of file onnxruntime_cxx_inline.h.

RunOptions & Ort::RunOptions::SetRunTag ( const char *  run_tag )

inline

wraps OrtApi::RunOptionsSetRunTag

Definition at line 501 of file onnxruntime_cxx_inline.h.

RunOptions & Ort::RunOptions::SetTerminate ( )

inline

Terminates all currently executing Session::Run calls that were made using this RunOptions instance.

If a currently executing session needs to be force terminated, this can be called from another thread to force it to fail with an error Wraps OrtApi::RunOptionsSetTerminate

Definition at line 517 of file onnxruntime_cxx_inline.h.

RunOptions & Ort::RunOptions::UnsetTerminate ( )

inline

Clears the terminate flag so this RunOptions instance can be used in a new Session::Run call without it instantly terminating.

Wraps OrtApi::RunOptionsUnsetTerminate

Definition at line 522 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