`Launcher`

The object coordinating the launching of Feko and external processes.

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 Launcher object is derived from the Object object.

Usage locations

The Launcher object can be accessed from the following locations:

Properties
- Application object has property Launcher.

Property List

CommandStringCADFEKO: Get the command that will be executed by the RunCADFEKO method. (Read only string)
CommandStringEDITFEKO: Get the command that will be executed by the RunEDITFEKO method. (Read only string)
CommandStringFEKO: Get the command that will be executed by the RunFEKO method. (Read only string)
CommandStringOPTFEKO: Get the command that will be executed by the RunOPTFEKO method. (Read only string)
CommandStringPOSTFEKO: Get the command that will be executed by the RunPOSTFEKO method. (Read only string)
CommandStringPREFEKO: Get the command that will be executed by the RunPREFEKO method. (Read only string)
Label: The object label. (Read/Write string)
Settings: The components launch options. (Read only ComponentLaunchOptions)
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.)
Run (executable string, arguments 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.)
RunAMRFEKO (): Runs AMRFEKO. (Returns a LaunchResult object.)
RunAMRFEKOAndContinue (): Run AMRFEKO without waiting for it to complete. The LaunchResult will not be available since it does not wait for completion.
RunCADFEKO (): Run CADFEKO.
RunEDITFEKO (): Run EDITFEKO.
RunFEKO (): Run Feko Solver. (Returns a LaunchResult object.)
RunFEKOAndContinue (): Run the Feko Solver without waiting for it to complete. The LaunchResult will not be available since it does not wait for completion.
RunOPTFEKO (): Run OPTFEKO. (Returns a LaunchResult object.)
RunOPTFEKOAndContinue (): Run OPTFEKO without waiting for it to complete. The LaunchResult will not be available since it does not wait for completion.
RunPOSTFEKO (): Run CADFEKO.
RunPREFEKO (): Rum PREFEKO. (Returns a LaunchResult object.)
RunPREFEKOAndContinue (): Run PREFEKO without waiting for it to complete. The LaunchResult will not be available since it does not wait for completion.
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

CommandStringCADFEKO

Get the command that will be executed by the RunCADFEKO method.

Type: string
Access: Read only

CommandStringEDITFEKO

Get the command that will be executed by the RunEDITFEKO method.

Type: string
Access: Read only

CommandStringFEKO

Get the command that will be executed by the RunFEKO method.

Type: string
Access: Read only

CommandStringOPTFEKO

Get the command that will be executed by the RunOPTFEKO method.

Type: string
Access: Read only

CommandStringPOSTFEKO

Get the command that will be executed by the RunPOSTFEKO method.

Type: string
Access: Read only

CommandStringPREFEKO

Get the command that will be executed by the RunPREFEKO method.

Type: string
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Settings

The components launch options.

Type: ComponentLaunchOptions
Access: Read only

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.

Run (executable string, arguments 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(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: Returns a LaunchResult object.

RunAMRFEKO ()

Runs AMRFEKO.

Return

LaunchResult: Returns a LaunchResult object.

RunAMRFEKOAndContinue ()

Run AMRFEKO without waiting for it to complete. The LaunchResult will not be available since it does not wait for completion.

RunCADFEKO ()

Run CADFEKO.

RunEDITFEKO ()

Run EDITFEKO.

RunFEKO ()

Run Feko Solver.

Return

LaunchResult: Returns a LaunchResult object.

RunFEKOAndContinue ()

Run the Feko Solver without waiting for it to complete. The LaunchResult will not be available since it does not wait for completion.

RunOPTFEKO ()

Run OPTFEKO.

Return

LaunchResult: Returns a LaunchResult object.

RunOPTFEKOAndContinue ()

Run OPTFEKO without waiting for it to complete. The LaunchResult will not be available since it does not wait for completion.

RunPOSTFEKO ()

Run CADFEKO.

RunPREFEKO ()

Rum PREFEKO.

Return

LaunchResult: Returns a LaunchResult object.

RunPREFEKOAndContinue ()

Run PREFEKO without waiting for it to complete. The LaunchResult will not be available since it does not wait for completion.

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.