This is the documentation for Enlighten.
class Enlighten LongRunningProcess
class Enlighten::LongRunningProcess
Class for handling a long running external process.
Functions
| Name | Description |
|---|---|
| Cancel() | Cancels the running process. |
| CheckComplete() | Checks if the process has completed or not. |
| GetRetCode() | Gets the return code of the process. Must have completed. |
| LongRunningProcess() | Constructor. |
| Start(const Geo::GeoFileString &) | Start a new long running process with the given commandline. |
| Wait() | Blocks until the process is complete. |
void Enlighten::LongRunningProcess::Cancel
public: void Cancel()
Cancels the running process.
bool Enlighten::LongRunningProcess::CheckComplete
public: bool CheckComplete()
Checks if the process has completed or not.
Returns
true if the process has completed, false if it is still running.
Geo::s32 Enlighten::LongRunningProcess::GetRetCode
public: Geo::s32 GetRetCode() const
Gets the return code of the process. Must have completed.
Enlighten::LongRunningProcess::LongRunningProcess
public: LongRunningProcess()
Constructor.
bool Enlighten::LongRunningProcess::Start
public: bool Start
(
const Geo::GeoFileString & commandline
)
Start a new long running process with the given commandline.
Uses Win32 'Jobs' to allow the entire process tree spawned by the precompute to be killed.
Returns
true if the process is already complete, false if it is running.
void Enlighten::LongRunningProcess::Wait
public: void Wait()
Blocks until the process is complete.