IProcess

​

Interface IProcess

interface IProcess

Extends IStandard The root OmniKit object of the process. The process object is an immortal singleton object obtained magically by each OmniKit language binding, usually by a call to a GetProcessObject() function specific to each language binding.

​

Methods

​

getComponent()

IStandard* getComponent(string name)

Top-level interface for getting a component. This function is the easy, general-purpose function for getting a component. It throws if the component cannot be found. See the OmniKit manual for a description of how component discovery works. TODO(colascid): throws what?

​

Parameters

name

string — Required component name

​

Returns

IStandard* component object

---

​

tryGetComponent()

IStandard? tryGetComponent(string name)

Top-level interface for getting a component. This function is like getComponent(), but returns nullptr instead of throwing if the component can’t be found. component. It is exactly equivalent to getEnvironment()->tryGetComponent(name).

​

Parameters

name

string — Required component name

​

Returns

IStandard? The return value is optional and might be absent. component or nullptr if the component can’t be found

---

​

makeError()

IError* makeError(string types, string message)

Top-level interface for creating an error object. TYPES is a comma-separated list of error types not including BaseError; see IError for a more detailed discussion of this data representation. MESSAGE is an arbitrary human-readable error message. It is not contractually preserved.

​

Parameters

types

string — Required the hierarchy of error types as a comma-separated list

message

string — Required the error message

​

Returns

IError* error object

---