`CFXModelImportSettings`

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

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Modify the CFX import settings

project.Importer.CFXModel.Settings.Prefix = "Dipole_"

    -- Use the 'CFXImporter' to import a model

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

Usage locations (object properties)

The following objects have properties using the CFXModelImportSettings object:

CFXModelImporter(.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)
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)
Prefix: The prefix to prepend. (Read/Write string)
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 all the settings to their default values.
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

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

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

Prefix

The prefix to prepend.

Type: string
Access: Read/Write

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 all the settings to their default values.

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.