ComponentLaunchOptions

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

Example

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

    -- Access the 'ComponentLaunchOptions' object and check the environment variables

environmentVariables = application.Launcher.Settings.Environment

Inheritance

The ComponentLaunchOptions object is derived from the Object object.

Usage locations

The ComponentLaunchOptions object can be accessed from the following locations:

Property List

ADAPTFEKO
The object containing the ADAPTFEKO options to be used when it is launched. (Read/Write ADAPTFEKOLaunchOptions)
AMRFEKO
The object containing the AMRFEKO options to be used when it is launched. (Read/Write AMRFEKOLaunchOptions)
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/Write FEKOLaunchOptions)
Label
The object label. (Read/Write string)
OPTFEKO
The object containing the OPTFEKO options to be used when it is launched. (Read/Write OPTFEKOLaunchOptions)
PREFEKO
The object containing the PREFEKO options to be used when it is launched. (Read/Write PREFEKOLaunchOptions)
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

ADAPTFEKO
The object containing the ADAPTFEKO options to be used when it is launched.
Type
ADAPTFEKOLaunchOptions
Access
Read/Write
AMRFEKO
The object containing the AMRFEKO options to be used when it is launched.
Type
AMRFEKOLaunchOptions
Access
Read/Write
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/Write
Label
The object label.
Type
string
Access
Read/Write
OPTFEKO
The object containing the OPTFEKO options to be used when it is launched.
Type
OPTFEKOLaunchOptions
Access
Read/Write
PREFEKO
The object containing the PREFEKO options to be used when it is launched.
Type
PREFEKOLaunchOptions
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.