`CFXModelImportSettings`

The CADFEKO model (*.cfx file) import settings.

Example

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

    -- Set some CFX import settings

cfxImporter = project.Importer.CFXModel
cfxImporter.Settings.ImportMeshRulesEnabled = false
cfxImporter.Settings.MergeIdenticalMediaEnabled = true


    -- Use the 'CFXImporter' to import a model

cfxImporter:Import(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]])

Inheritance

The CFXModelImportSettings object is derived from the Object object.

Usage locations

The CFXModelImportSettings object can be accessed from the following locations:

Properties
- CFXModelImporter object has property Settings.

Property List

ImportCableDefinitionsEnabled: Enable the importing of cable definitions from the CADFEKO model. (Read/Write boolean)
ImportGeometryEnabled: Enable the importing of geometry from the CADFEKO model. (Read/Write boolean)
ImportMeshEnabled: Enable the importing of meshes from the CADFEKO model. (Read/Write boolean)
ImportMeshRulesEnabled: Enable the importing of mesh rules from the CADFEKO model. (Read/Write boolean)
ImportOptimisationSearchesEnabled: Enable the importing of optimisation searches from the CADFEKO model. (Read/Write boolean)
ImportSolutionEntitiesEnabled: Enable the importing of solution entities from the CADFEKO model. (Read/Write boolean)
Label: The object label. (Read/Write string)
MergeIdenticalMediaEnabled: Enable the merging of identical media imported from the CADFEKO model. (Read/Write boolean)
MergeIdenticalVariablesEnabled: Enable the merging of identical variables imported from the CADFEKO model. (Read/Write boolean)
MergeIdenticalWorkplanesEnabled: Enable the merging of identical workplanes imported from the CADFEKO model. (Read/Write boolean)
Prefix: The prefix to prepend. (Read/Write string)
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.)
RestoreDefaults (): Restores all the settings to their default values.
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

ImportCableDefinitionsEnabled

Enable the importing of cable definitions from the CADFEKO model.

Type: boolean
Access: Read/Write

ImportGeometryEnabled

Enable the importing of geometry from the CADFEKO model.

Type: boolean
Access: Read/Write

ImportMeshEnabled

Enable the importing of meshes from the CADFEKO model.

Type: boolean
Access: Read/Write

ImportMeshRulesEnabled

Enable the importing of mesh rules from the CADFEKO model.

Type: boolean
Access: Read/Write

ImportOptimisationSearchesEnabled

Enable the importing of optimisation searches from the CADFEKO model.

Type: boolean
Access: Read/Write

ImportSolutionEntitiesEnabled

Enable the importing of solution entities from the CADFEKO model.

Type: boolean
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

MergeIdenticalMediaEnabled

Enable the merging of identical media imported from the CADFEKO model.

Type: boolean
Access: Read/Write

MergeIdenticalVariablesEnabled

Enable the merging of identical variables imported from the CADFEKO model.

Type: boolean
Access: Read/Write

MergeIdenticalWorkplanesEnabled

Enable the merging of identical workplanes imported from the CADFEKO model.

Type: boolean
Access: Read/Write

Prefix

The prefix to prepend.

Type: string
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.

RestoreDefaults ()

Restores all the settings to their default values.

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.