Launcher

The object coordinating the launching of Feko and external processes.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]])

    -- Save a copy of the file before running PREFEKO
    
app:SaveAs("temp_Dipole_Example.cfx")

    -- Launch PREFEKO on the model

results = project.Launcher:RunPREFEKO()

    -- Check the result of the run

success = results.Succeeded

Usage locations (object properties)

The following objects have properties using the Launcher object:

Property List

Settings
The components launch options. (Read only ComponentLaunchOptions)
Type
The object type string. (Read only string)

Method List

GetCommandRunCADFEKO ()
Get the command that will be executed by the RunCADFEKO method. (Returns a string object.)
GetCommandRunEDITFEKO ()
Get the command that will be executed by the RunEDITFEKO method. (Returns a string object.)
GetCommandRunFEKO ()
Get the command that will be executed by the RunFEKO method. (Returns a string object.)
GetCommandRunOPTFEKO ()
Get the command that will be executed by the RunOPTFEKO method. (Returns a string object.)
GetCommandRunPOSTFEKO ()
Get the command that will be executed by the RunPOSTFEKO method. (Returns a string object.)
GetCommandRunPREFEKO ()
Get the command that will be executed by the RunPREFEKO method. (Returns a string object.)
RunCADFEKO ()
Run CADFEKO. (Returns a boolean object.)
RunEDITFEKO ()
Run EDITFEKO. (Returns a boolean object.)
RunFEKO ()
Run Feko Solver. (Returns a LaunchResult object.)
RunOPTFEKO ()
Run OPTFEKO. (Returns a LaunchResult object.)
RunPOSTFEKO ()
Run POSTFEKO. (Returns a boolean object.)
RunPREFEKO ()
Run PREFEKO. (Returns a LaunchResult object.)

Constructor Function List

Run (executable string, arguments List of string)
Launch the given executable with a list of arguments and process the output. CAUTION, the process that is called could be blocking and will halt your program execution until it is complete. (Returns a LaunchResult object.)
Run (command string)
Launch the given command and process the output. CAUTION, the process that is called could be blocking and will halt your program execution until it is complete. (Returns a LaunchResult object.)

Property Details

Settings
The components launch options.
Type
ComponentLaunchOptions
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

GetCommandRunCADFEKO ()
Get the command that will be executed by the RunCADFEKO method.
Return
string
The command string.
GetCommandRunEDITFEKO ()
Get the command that will be executed by the RunEDITFEKO method.
Return
string
The command string.
GetCommandRunFEKO ()
Get the command that will be executed by the RunFEKO method.
Return
string
The command string.
GetCommandRunOPTFEKO ()
Get the command that will be executed by the RunOPTFEKO method.
Return
string
The command string.
GetCommandRunPOSTFEKO ()
Get the command that will be executed by the RunPOSTFEKO method.
Return
string
The command string.
GetCommandRunPREFEKO ()
Get the command that will be executed by the RunPREFEKO method.
Return
string
The command string.
RunCADFEKO ()
Run CADFEKO.
Return
boolean
The success of launching CADFEKO.
RunEDITFEKO ()
Run EDITFEKO.
Return
boolean
The success of launching EDITFEKO.
RunFEKO ()
Run Feko Solver.
Return
LaunchResult
The process run result.
RunOPTFEKO ()
Run OPTFEKO.
Return
LaunchResult
The process run result.
RunPOSTFEKO ()
Run POSTFEKO.
Return
boolean
The success of launching POSTFEKO.
RunPREFEKO ()
Run PREFEKO.
Return
LaunchResult
The process run result.

Static Function Details

Run (executable string, arguments List of string)
Launch the given executable with a list of arguments and process the output. CAUTION, the process that is called could be blocking and will halt your program execution until it is complete.
Input Parameters
executable(string)
The program to execute.
arguments(List of string)
The arguments send to the executable.
Return
LaunchResult
A LaunchResult containing the results of this run.
Run (command string)
Launch the given command and process the output. CAUTION, the process that is called could be blocking and will halt your program execution until it is complete.
Input Parameters
command(string)
The command to execute.
Return
LaunchResult
A LaunchResult containing the results of this run.