`Media`

The media section of the definitions of the CADFEKO model.

Example

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

    -- Add a dielectric to the project media

project.Definitions.Media.Dielectric:AddDielectric()

Inheritance

The Media object is derived from the Object object.

Usage locations

The Media object can be accessed from the following locations:

Properties
- ModelDefinitions object has property Media.

Property List

DefaultMedium: A non-physical medium that can be applied to a face or region. It allows the properties to be inferred from the surrounding face or region settings. (Read only DefaultMedium)
DielectricBoundaryMedium: A non-physical medium that can be applied to a face to describe the separation between two dielectric regions. (Read only DielectricBoundaryMedium)
FreeSpace: The standard free space medium. (Read only FreeSpace)
GroundPlaneMedium: The finite ground plane medium. Only applies if a Planar multilayer substrate has been defined. (Read only GroundPlaneMedium)
Label: The object label. (Read/Write string)
PerfectElectricConductor: The standard perfect electric conductor medium. (Read only PerfectElectricConductor)
PerfectMagneticConductor: The standard perfect magnetic conductor medium. (Read only PerfectMagneticConductor)
Type: The object type string. (Read only string)
Zero: A non-physical medium that can be used with 3D anisotropic media. It represents no coupling to the particular tensor component. (Read only Zero)

Collection List

AnisotropicDielectric: The 3D anisotropic media. (AnisotropicDielectricCollection of AnisotropicDielectric.)
CharacterisedSurface: The characterised surface media. (CharacterisedSurfaceCollection of CharacterisedSurface.)
Dielectric: The dielectric media. (DielectricCollection of Dielectric.)
ImpedanceSheet: The impedance sheet media. (ImpedanceSheetCollection of ImpedanceSheet.)
LayeredDielectric: he layered dielectric media. (LayeredDielectricCollection of LayeredDielectric.)
Metallic: The non-default metallic media. (MetalCollection of Metal.)
Windscreen: The windscreen media. (WindscreenCollection of Windscreen.)

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

DefaultMedium

A non-physical medium that can be applied to a face or region. It allows the properties to be inferred from the surrounding face or region settings.

Type: DefaultMedium
Access: Read only

DielectricBoundaryMedium

A non-physical medium that can be applied to a face to describe the separation between two dielectric regions.

Type: DielectricBoundaryMedium
Access: Read only

FreeSpace

The standard free space medium.

Type: FreeSpace
Access: Read only

GroundPlaneMedium

The finite ground plane medium. Only applies if a Planar multilayer substrate has been defined.

Type: GroundPlaneMedium
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

PerfectElectricConductor

The standard perfect electric conductor medium.

Type: PerfectElectricConductor
Access: Read only

PerfectMagneticConductor

The standard perfect magnetic conductor medium.

Type: PerfectMagneticConductor
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Zero

A non-physical medium that can be used with 3D anisotropic media. It represents no coupling to the particular tensor component.

Type: Zero
Access: Read only

Collection Details

AnisotropicDielectric

The 3D anisotropic media.

Type: AnisotropicDielectricCollection

CharacterisedSurface

The characterised surface media.

Type: CharacterisedSurfaceCollection

Dielectric

The dielectric media.

Type: DielectricCollection

ImpedanceSheet

The impedance sheet media.

Type: ImpedanceSheetCollection

LayeredDielectric

he layered dielectric media.

Type: LayeredDielectricCollection

Metallic

The non-default metallic media.

Type: MetalCollection

Windscreen

The windscreen media.

Type: WindscreenCollection

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.