OnnxRuntime
Ort::RunOptions Struct Reference

#include <onnxruntime_cxx_api.h>

Inherits Ort::Base< OrtRunOptions >.

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...
 
RunOptionsSetRunLogVerbosityLevel (int)
 Wraps OrtApi::RunOptionsSetRunLogVerbosityLevel. More...
 
int GetRunLogVerbosityLevel () const
 Wraps OrtApi::RunOptionsGetRunLogVerbosityLevel. More...
 
RunOptionsSetRunLogSeverityLevel (int)
 Wraps OrtApi::RunOptionsSetRunLogSeverityLevel. More...
 
int GetRunLogSeverityLevel () const
 Wraps OrtApi::RunOptionsGetRunLogSeverityLevel. More...
 
RunOptionsSetRunTag (const char *run_tag)
 wraps OrtApi::RunOptionsSetRunTag More...
 
const char * GetRunTag () const
 Wraps OrtApi::RunOptionsGetRunTag. More...
 
RunOptionsAddConfigEntry (const char *config_key, const char *config_value)
 Wraps OrtApi::AddRunConfigEntry. More...
 
RunOptionsSetTerminate ()
 Terminates all currently executing Session::Run calls that were made using this RunOptions instance. More...
 
RunOptionsUnsetTerminate ()
 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::Base< OrtRunOptions >
 Base ()=default
 
 Base (OrtRunOptions *p)
 
 ~Base ()
 
 operator OrtRunOptions * ()
 
 operator const OrtRunOptions * () const
 
OrtRunOptionsrelease ()
 Releases ownership of the contained pointer. More...
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ RunOptions() [1/2]

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

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

◆ RunOptions() [2/2]

Ort::RunOptions::RunOptions ( )

Member Function Documentation

◆ AddConfigEntry()

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

◆ GetRunLogSeverityLevel()

int Ort::RunOptions::GetRunLogSeverityLevel ( ) const

◆ GetRunLogVerbosityLevel()

int Ort::RunOptions::GetRunLogVerbosityLevel ( ) const

◆ GetRunTag()

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

◆ SetRunLogSeverityLevel()

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

◆ SetRunLogVerbosityLevel()

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

◆ SetRunTag()

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

◆ SetTerminate()

RunOptions & Ort::RunOptions::SetTerminate ( )

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

◆ UnsetTerminate()

RunOptions & Ort::RunOptions::UnsetTerminate ( )

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

Wraps OrtApi::RunOptionsUnsetTerminate