Choreonoid  1.5
Public Types | Public Member Functions | Static Public Member Functions | List of all members
cnoid::PythonExecutor Class Reference

#include <PythonExecutor.h>

Public Types

enum  State { NOT_RUNNING, RUNNING_FOREGROUND, RUNNING_BACKGROUND }
 

Public Member Functions

 PythonExecutor ()
 
 PythonExecutor (const PythonExecutor &org)
 
 ~PythonExecutor ()
 
void setBackgroundMode (bool on)
 
bool isBackgroundMode () const
 
State state () const
 
bool execCode (const std::string &code)
 
bool execFile (const std::string &filename)
 
bool waitToFinish (double timeout)
 
boost::python::object resultObject ()
 
const std::string resultString () const
 
SignalProxy< void()> sigFinished ()
 
bool hasException () const
 
const std::string exceptionTypeName () const
 
const std::string exceptionText () const
 
boost::python::object exceptionType () const
 
boost::python::object exceptionValue () const
 
bool isTerminated () const
 
bool terminate ()
 

Static Public Member Functions

static void setModuleRefreshEnabled (bool on)
 

Member Enumeration Documentation

◆ State

Enumerator
NOT_RUNNING 
RUNNING_FOREGROUND 
RUNNING_BACKGROUND 

Constructor & Destructor Documentation

◆ PythonExecutor() [1/2]

PythonExecutor::PythonExecutor ( )

◆ PythonExecutor() [2/2]

PythonExecutor::PythonExecutor ( const PythonExecutor org)

◆ ~PythonExecutor()

PythonExecutor::~PythonExecutor ( )

Member Function Documentation

◆ exceptionText()

const std::string PythonExecutor::exceptionText ( ) const

◆ exceptionType()

boost::python::object PythonExecutor::exceptionType ( ) const
Note
GIL must be obtained when accessing this object.

◆ exceptionTypeName()

const std::string PythonExecutor::exceptionTypeName ( ) const
Note
The name includes module components.

◆ exceptionValue()

boost::python::object PythonExecutor::exceptionValue ( ) const
Note
GIL must be obtained when accessing this object.

◆ execCode()

bool PythonExecutor::execCode ( const std::string &  code)

◆ execFile()

bool PythonExecutor::execFile ( const std::string &  filename)

◆ hasException()

bool PythonExecutor::hasException ( ) const

◆ isBackgroundMode()

bool PythonExecutor::isBackgroundMode ( ) const

◆ isTerminated()

bool PythonExecutor::isTerminated ( ) const

◆ resultObject()

boost::python::object PythonExecutor::resultObject ( )
Note
GIL must be obtained when accessing this object.

◆ resultString()

const std::string PythonExecutor::resultString ( ) const

◆ setBackgroundMode()

void PythonExecutor::setBackgroundMode ( bool  on)

◆ setModuleRefreshEnabled()

void PythonExecutor::setModuleRefreshEnabled ( bool  on)
static

◆ sigFinished()

SignalProxy< void()> PythonExecutor::sigFinished ( )

◆ state()

PythonExecutor::State PythonExecutor::state ( ) const

◆ terminate()

bool PythonExecutor::terminate ( )

◆ waitToFinish()

bool PythonExecutor::waitToFinish ( double  timeout)

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