`ModelContents`

The contents section of the CADFEKO model.

Example

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

    -- Add a cuboid by accessing the model contents

cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1)

Inheritance

The ModelContents object is derived from the Object object.

Usage locations

The ModelContents object can be accessed from the following locations:

Properties
- Model object has property Contents.

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Label: The object label. (Read/Write string)
Locked: A boolean that indicates whether the entity or it's ancestor is locked or not. (Read/Write boolean)
SolutionSettings: The model solution settings. (Read only SolutionSettings)
Type: The object type string. (Read only string)

Collection List

CableHarnesses: The collection of cable harnesses in the model. (CableHarnessCollection of CableHarness.)
Cutplanes: The collection of cutplanes in the model. (CutplaneCollection of Cutplane.)
Geometry: The collection of geometry in the model. (GeometryCollection of Geometry.)
MeshRefinementRules: The collection of mesh refinement rules in the model. (MeshRefinementRuleCollection of MeshRefinementRule.)
Meshes: The collection of editable (unlinked/imported) meshes in the model. (MeshCollection of Mesh.)
Ports: The collection of ports in the model. (PortCollection of Port.)
SolutionConfigurations: The collection of solution configurations in the model. (SolutionConfigurationCollection of SolutionConfiguration.)

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.)
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

BoundingBox

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

Type: Box
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Locked

A boolean that indicates whether the entity or it's ancestor is locked or not.

Type: boolean
Access: Read/Write

SolutionSettings

The model solution settings.

Type: SolutionSettings
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Collection Details

CableHarnesses

The collection of cable harnesses in the model.

Type: CableHarnessCollection

Cutplanes

The collection of cutplanes in the model.

Type: CutplaneCollection

Geometry

The collection of geometry in the model.

Type: GeometryCollection

MeshRefinementRules

The collection of mesh refinement rules in the model.

Type: MeshRefinementRuleCollection

Meshes

The collection of editable (unlinked/imported) meshes in the model.

Type: MeshCollection

Ports

The collection of ports in the model.

Type: PortCollection

SolutionConfigurations

The collection of solution configurations in the model.

Type: SolutionConfigurationCollection

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.

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.