`ModelDefinitions`

The definitions section of the CADFEKO model.

Example

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

    -- Create a variable using the model definitions

frequencyVar = project.Definitions.Variables:Add("frequency", 100e6, "The operating frequency")

Inheritance

The ModelDefinitions object is derived from the Object object.

Usage locations

The ModelDefinitions object can be accessed from the following locations:

Properties
- Model object has property Definitions.

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Cables: A grouping of cable functionality. (Read only Cables)
Label: The object label. (Read/Write string)
Media: The collection of media in the model. (Read only Media)
Type: The object type string. (Read only string)

Collection List

FieldDataList: The collection of field data definitions in the model. (FieldDataCollection of FieldData.)
NamedPoints: The collection of named points in the model. (NamedPointCollection of NamedPoint.)
Variables: The collection of variables in the model. (VariableCollection of Variable.)
WorkSurfaces: The collection of work surfaces in the model. (WorkSurfaceCollection of WorkSurface.)
Workplanes: The collection of work planes in the model. (WorkplaneCollection of Workplane.)

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

Cables

A grouping of cable functionality.

Type: Cables
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Media

The collection of media in the model.

Type: Media
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Collection Details

FieldDataList

The collection of field data definitions in the model.

Type: FieldDataCollection

NamedPoints

The collection of named points in the model.

Type: NamedPointCollection

Variables

The collection of variables in the model.

Type: VariableCollection

WorkSurfaces

The collection of work surfaces in the model.

Type: WorkSurfaceCollection

Workplanes

The collection of work planes in the model.

Type: WorkplaneCollection

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.