`PCB`

The PCB importer.

Example

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

project.Importer.PCB:Import(cf.Enums.PCBImportTypeEnum.PEMA, FEKO_HOME..[[/shared/Resources/Automation/sample.pema]])

Inheritance

The PCB object is derived from the Object object.

Usage locations

The PCB object can be accessed from the following locations:

Properties
- Importer object has property PCB.

Property List

HealAndSimplifyRepresentation: Heal and simplify the substrates, vias and tracks as part of the import. (Read/Write boolean)
ImportScaleFactor: The factor by which the imported geometry will be scaled. This value must be greater than 0. (Read/Write number)
ImportViasEnabled: Enables the importing of PCB vias. (Read/Write boolean)
IncludeBoardOutline: Value that enables the import of the board outline/drill definition that is applied to all layers. (Read/Write boolean)
IncludeLayerDielectric: Value that enables the import of dielectric/substrate layers. (Read/Write boolean)
IncludeLayerSignal: Value that enables the import of the signal/power layers that include traces. (Read/Write boolean)
IncludeLayerSilkscreen: Value that enables the import of silkscreen demarcations that can include text, shapes and logos. (Read/Write boolean)
IncludeLayerSolderPaste: Value that enables the import of solder paste layers. (Read/Write boolean)
IncludeLayerSolderResist: Value that enables the import of insulating/non-conducting solder resist layers. (Read/Write boolean)
IncludeLayerUserDefined: Value that enables the import of user defined layers. (Read/Write boolean)
Label: The object label. (Read/Write string)
SimplifyEnabled: Simplifies the imported geometry. (Read/Write boolean)
Type: The object type string. (Read only string)
UnionEnabled: Unions the imported geometry. (Read/Write boolean)
UseInfinitelyThinLayersEnabled: Enables the simplification of finite thickness faces to be infinitely thin. (Read/Write boolean)

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.)
Import (filetype PCBImportTypeEnum, filename string): Import the specified file.
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

HealAndSimplifyRepresentation

Heal and simplify the substrates, vias and tracks as part of the import.

Type: boolean
Access: Read/Write

ImportScaleFactor

The factor by which the imported geometry will be scaled. This value must be greater than 0.

Type: number
Access: Read/Write

ImportViasEnabled

Enables the importing of PCB vias.

Type: boolean
Access: Read/Write

IncludeBoardOutline

Value that enables the import of the board outline/drill definition that is applied to all layers.

Type: boolean
Access: Read/Write

IncludeLayerDielectric

Value that enables the import of dielectric/substrate layers.

Type: boolean
Access: Read/Write

IncludeLayerSignal

Value that enables the import of the signal/power layers that include traces.

Type: boolean
Access: Read/Write

IncludeLayerSilkscreen

Value that enables the import of silkscreen demarcations that can include text, shapes and logos.

Type: boolean
Access: Read/Write

IncludeLayerSolderPaste

Value that enables the import of solder paste layers.

Type: boolean
Access: Read/Write

IncludeLayerSolderResist

Value that enables the import of insulating/non-conducting solder resist layers.

Type: boolean
Access: Read/Write

IncludeLayerUserDefined

Value that enables the import of user defined layers.

Type: boolean
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

SimplifyEnabled

Simplifies the imported geometry.

Type: boolean
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

UnionEnabled

Unions the imported geometry.

Type: boolean
Access: Read/Write

UseInfinitelyThinLayersEnabled

Enables the simplification of finite thickness faces to be infinitely thin.

Type: boolean
Access: Read/Write

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.

Import (filetype PCBImportTypeEnum, filename string)

Import the specified file.

Input Parameters

filetype(PCBImportTypeEnum): The file type to be imported.
filename(string): The name of the file to be imported.

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.