`LaunchResult`

The result of last Feko or external process run.

Example

application = cf.Application.getInstance()
project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]]})

    -- Save a copy of the file before running PREFEKO

application:SaveAs("temp_Dipole_Example.cfx")

    -- Launch PREFEKO on the model

results = application.Launcher:RunPREFEKO()

    -- Check the result of the run

success = results.Succeeded

Inheritance

The LaunchResult object is derived from the Object object.

Usage locations

The LaunchResult object can be accessed from the following locations:

Methods
- Launcher object has method Run(string, string).
- Launcher object has method Run(string).
- Launcher object has method RunFEKO().
- Launcher object has method RunOPTFEKO().
- Launcher object has method RunPREFEKO().

Property List

Errors: The error messages for the process run. (Read/Write string)
ExitCode: The exit code of the process run. (Read/Write number)
Label: The object label. (Read/Write string)
Output: The standard output for the process run. (Read/Write string)
Succeeded: The success of the process run. (Read/Write boolean)
Type: The object type string. (Read only string)

Method List

Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Errors

The error messages for the process run.

Type: string
Access: Read/Write

ExitCode

The exit code of the process run.

Type: number
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

Output

The standard output for the process run.

Type: string
Access: Read/Write

Succeeded

The success of the process run.

Type: boolean
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.