ComponentLaunchOptions

The components launch options that specifies the command line parameters for the various Altair Feko components.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]])

    -- Access the 'ComponentLaunchOptions' object and check the environment variables
    
environmentVariables = app.Models[1].Launcher.Settings.Environment

Usage locations (object properties)

The following objects have properties using the ComponentLaunchOptions object:

Property List

ADAPTFEKO
The object containing the ADAPTFEKO options to be used when it is launched. (Read only ADAPTFEKOLaunchOptions)
Environment
The string to define ENVIRONMENT variables to be used during the launching of processes. The format is VARIABLE=VALUE. (Read/Write string)
FEKO
The object containing the Feko Solver options to be used when it is launched. (Read only FEKOLaunchOptions)
OPTFEKO
The object containing the OPTFEKO options to be used when it is launched. (Read only OPTFEKOLaunchOptions)
PREFEKO
The object containing the PREFEKO options to be used when it is launched. (Read only PREFEKOLaunchOptions)
Type
The object type string. (Read only string)

Method List

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.)
RestoreDefaults ()
Restores the default components launch options.
SetProperties (properties table)
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.

Property Details

ADAPTFEKO
The object containing the ADAPTFEKO options to be used when it is launched.
Type
ADAPTFEKOLaunchOptions
Access
Read only
Environment
The string to define ENVIRONMENT variables to be used during the launching of processes. The format is VARIABLE=VALUE.
Type
string
Access
Read/Write
FEKO
The object containing the Feko Solver options to be used when it is launched.
Type
FEKOLaunchOptions
Access
Read only
OPTFEKO
The object containing the OPTFEKO options to be used when it is launched.
Type
OPTFEKOLaunchOptions
Access
Read only
PREFEKO
The object containing the PREFEKO options to be used when it is launched.
Type
PREFEKOLaunchOptions
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

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 properties table.
RestoreDefaults ()
Restores the default components launch options.
SetProperties (properties table)
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(table)
A table of properties defining the new state of the object.