RobWorkProject  23.9.11-
Public Member Functions | List of all members
RobWorkStudioApp Class Reference

a RobWorkStudio main application which may be instantiated in its own thread. The app can be started with either a call to the run() function or the start() function depending on weather you want to run it from current thread or start it up in another tread. More...

#include <RobWorkStudioApp.hpp>

Public Member Functions

 RobWorkStudioApp (const std::string &args="")
 constructor More...
 
virtual ~RobWorkStudioApp ()
 destructor
 
void start ()
 start RobWorkStudio in its own thread, the function is blocking until rws is up and running
 
int run ()
 start RobWorkStudio in this thread. Notice this method call will block until RobWorkStudio is exited. More...
 
bool isRunning ()
 check if RobwWrkStudio is running More...
 
void close ()
 Close RobWorkStudio. Blocking until rws is closed. This might take awaile.
 
 DEPRECATED ("In the feuture this will return RobWorkStudio::Ptr instead of RobWorkStudio*. use " "#define RWS_USE_PTR before including this file to enable the new behavior")
 get handle to the running RobWorkStudio instance. More...
 
RobWorkStudiogetRobWorkStudio ()
 

Detailed Description

a RobWorkStudio main application which may be instantiated in its own thread. The app can be started with either a call to the run() function or the start() function depending on weather you want to run it from current thread or start it up in another tread.

For convinienve when running the app from the main tread the macros RWS_START(RobWorkStudioApp app) and RWS_END() can be used to capsulate code to run in a new thread

Constructor & Destructor Documentation

◆ RobWorkStudioApp()

RobWorkStudioApp ( const std::string &  args = "")
inline

constructor

Parameters
args[in] command line arguments for RobWorkStudio

Member Function Documentation

◆ DEPRECATED()

DEPRECATED ( "In the feuture this will return RobWorkStudio::Ptr instead of RobWorkStudio*. use " "#define RWS_USE_PTR before including this file to enable the new behavior"  )

get handle to the running RobWorkStudio instance.

Note
do not directly change Qt visualization objects, this will produce segfaults. Instead use Qt events and the post* handles on RobWorkStudio interface.
Returns
handle to RobWorkStudio

◆ isRunning()

bool isRunning ( )
inline

check if RobwWrkStudio is running

Returns
true if running false otherwise

◆ run()

int run ( )

start RobWorkStudio in this thread. Notice this method call will block until RobWorkStudio is exited.

Returns
zero if exited normally.

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