`Model`

The CADFEKO Model.

Example

application = cf.Application.GetInstance()

    -- Open an existing project

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

    -- Create a new project and set the model unit to feet

project = application:NewProject()
project.ModelAttributes.Unit = cf.Enums.ModelUnitEnum.Feet

Inheritance

The Model object is derived from the Object object.

Usage locations

The Model object can be accessed from the following locations:

Properties
- Application object has property Project.

Property List

AbsoluteFilePath: The full path of the project file (directory path and file name including the file extension). (Read only string)
AbsolutePath: The full directory path of the project file (directory path excluding the file name and extension). (Read only string)
BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Contents: The contents section of the CADFEKO model. (Read only ModelContents)
Definitions: The definition section of the CADFEKO model. (Read only ModelDefinitions)
Exporter: The model (geometry and mesh) exporter. (Read only Exporter)
Importer: The model (geometry and mesh) importer. (Read only Importer)
Label: The object label. (Read/Write string)
Mesher: The model mesher. (Read only Mesher)
ModelAttributes: The model attributes. (Read only ModelAttributes)
Optimisation: The optimisation configuration. (Read only Optimisation)
Title: The title of the model. (Read only string)
Type: The object type string. (Read only string)
Visible: Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

Method List

Delete (): Deletes the entity.
DeleteEntities (entities List of Object): Deletes the given list of entities. The entities may be in different collections.
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

AbsoluteFilePath

The full path of the project file (directory path and file name including the file extension).

Type: string
Access: Read only

AbsolutePath

The full directory path of the project file (directory path excluding the file name and extension).

Type: string
Access: Read only

BoundingBox

A box indicating the bounding box of this entity. (Read only Box).

Type: Box
Access: Read only

Contents

The contents section of the CADFEKO model.

Type: ModelContents
Access: Read only

Definitions

The definition section of the CADFEKO model.

Type: ModelDefinitions
Access: Read only

Exporter

The model (geometry and mesh) exporter.

Type: Exporter
Access: Read only

Importer

The model (geometry and mesh) importer.

Type: Importer
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Mesher

The model mesher.

Type: Mesher
Access: Read only

ModelAttributes

The model attributes.

Type: ModelAttributes
Access: Read only

Optimisation

The optimisation configuration.

Type: Optimisation
Access: Read only

Title

The title of the model.

Type: string
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Visible

Specifies whether the geometry must be shown or hidden.

Type: boolean
Access: Read/Write

Method Details

Delete ()

Deletes the entity.

DeleteEntities (entities List of Object)

Deletes the given list of entities. The entities may be in different collections.

Input Parameters

entities(List of Object): The list of entities to delete.

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.