CFXModelImporter

The CADFEKO model (*.cfx file) importer.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Use the 'CFXImporter' to import a model

project.Importer.CFXModel:Import(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]])

Inheritance

The CFXModelImporter object is derived from the Object object.

Usage locations

The CFXModelImporter object can be accessed from the following locations:

  • Properties

Property List

Label
The object label. (Read/Write string)
Settings
The settings to be used when importing the CADFEKO model. (Read only CFXModelImportSettings)
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.)
Import (filename string)
Import the specified file using default settings.
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

Label
The object label.
Type
string
Access
Read/Write
Settings
The settings to be used when importing the CADFEKO model.
Type
CFXModelImportSettings
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.
Import (filename string)
Import the specified file using default settings.
Input Parameters
filename(string)
The name of the file to be imported.
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.