`Application`

The CADFEKO Application.

Example

    -- The "GetInstance" function lives in the "Application" namespace and
    -- returns the current CADFEKO application object.

application = cf.Application.GetInstance()

    -- Open an example file located in the FEKO_HOME folder

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

Inheritance

The Application object is derived from the Object object.

Usage locations

The Application object can be accessed from the following locations:

Static functions
- Application object has static function GetInstance().

Property List

Label: The object label. (Read/Write string)
Launcher: The application launcher. (Read only Launcher)
MainWindow: The main window of the application. (Read only MainWindow)
MessageWindow: The application message window. (Read only MessageWindow)
Project: The application project. (Read only Model)
Type: The object type string. (Read only string)
Version: The application version. (Read only Version)

Collection List

MediaLibrary: The media library. (MediaLibrary of LibraryMedium.)

Method List

CloseProject (): Closes an open project.
Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
Exit (): Exit the application.
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.)
Load (filename string): Loads a new project. (Returns a Object object.)
NewProject (): Creates a new project. (Returns a Object object.)
NonInteractiveModeEnabled (): Returns true if the application is running in non-interactive mode. (Returns a boolean object.)
Redo (): Redo the last model operation. (Returns a boolean object.)
Save (): Saves the current session.
SaveAs (filename string): Saves the current model with the given name.
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.
Undo (): Undo the last model operation. (Returns a boolean object.)
getApplicationName (): The application name. (Returns a string object.)
getApplicationVersion (): The application version string. (Returns a string object.)

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)
GetInstance (): Returns an instance of the CADFEKO application object. (Returns a Application object.)

Property Details

Label

The object label.

Type: string
Access: Read/Write

Launcher

The application launcher.

Type: Launcher
Access: Read only

MainWindow

The main window of the application.

Type: MainWindow
Access: Read only

MessageWindow

The application message window.

Type: MessageWindow
Access: Read only

Project

The application project.

Type: Model
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Version

The application version.

Type: Version
Access: Read only

Collection Details

MediaLibrary

The media library.

Type: MediaLibrary

Method Details

CloseProject ()

Closes an open project.

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

Exit ()

Exit the application.

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.

Load (filename string)

Loads a new project.

Input Parameters

filename(string): The name of the file to load.

Return

Object: The application project.

NewProject ()

Creates a new project.

Return

Object: The application project.

NonInteractiveModeEnabled ()

Returns true if the application is running in non-interactive mode.

Return

boolean: The non-interactive mode.

Redo ()

Redo the last model operation.

Return

boolean: Returns true if the redo operation was successfull.

Save ()

Saves the current session.

SaveAs (filename string)

Saves the current model with the given name.

Input Parameters

filename(string): The name of the cfx file.

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.

Undo ()

Undo the last model operation.

Return

boolean: Returns true if the undo operation was successfull.

getApplicationName ()

The application name.

Return

string: Return the application name.

getApplicationVersion ()

The application version string.

Return

string: Return the version string.

Static Function Details

GetDefaultProperties ()

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

Return

table: A table containing the default properties.

GetInstance ()

Returns an instance of the CADFEKO application object.

Return

Application: An instance of the CADFEKO application object.