`Medium`

A medium.

Example

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

    -- Create a dielectric medium

dielectric = project.Definitions.Media.Dielectric:AddDielectric(2.16, 0.001, 1000)

    -- Delete the dielectric medium

dielectric:Delete()

Inheritance

The Medium object is derived from the Object object.

The following objects are derived (specialisations) from the Medium object:

Usage locations

The Medium object can be accessed from the following locations:

Properties
- CableBundleCrossSection object has property InsulationMedium.
- CableBundleCrossSection object has property CoatingMedium.
- CableCoaxialCrossSection object has property CoreMedium.
- CableCoaxialCrossSection object has property CoatingMedium.
- CableNonConductingElementCrossSection object has property FibreMedium.
- CableRibbonCrossSection object has property CoreMedium.
- CableRibbonCrossSection object has property InsulationMedium.
- CableSingleConductorCrossSection object has property CoreMedium.
- CableSingleConductorCrossSection object has property InsulationMedium.
- CableTwistedPairCrossSection object has property CoreMedium.
- CableTwistedPairCrossSection object has property InsulationMedium.
- MeshCurvilinearTriangleFace object has property MeshBackMedium.
- MeshCurvilinearTriangleFace object has property MeshFrontMedium.
- MeshCurvilinearTriangleFace object has property Medium.
- MeshCurvilinearTriangleFace object has property Coating.
- MeshTriangleFace object has property Medium.
- MeshTriangleFace object has property Coating.
- MeshCurvilinearSegmentWire object has property SurroundingMedium.
- MeshCurvilinearSegmentWire object has property CoreMedium.
- MeshCurvilinearSegmentWire object has property Coating.
- MeshSegmentWire object has property SurroundingMedium.
- MeshSegmentWire object has property CoreMedium.
- MeshSegmentWire object has property Coating.
- MeshPlate object has property Medium.
- MeshPlate object has property Coating.
- MeshTetrahedronRegion object has property Medium.
- MeshTetrahedronRegion object has property SolutionMedium.
- Edge object has property SurroundingMedium.
- Edge object has property CoreMedium.
- Edge object has property Coating.
- Face object has property Medium.
- Face object has property Coating.
- Region object has property Medium.
- Region object has property SolutionMedium.
- TransmissionLine object has property Medium.
- GroundPlane object has property Medium.
- SAR object has property SpecifiedMedium.
- LibraryMedium object has property Medium.
- ShieldLayerSettings object has property FilamentMedium.
- ShieldLayerSettings object has property ShieldMedium.
- ShieldLayerSettings object has property InsideBraidFixingMedium.
- ShieldLayerSettings object has property OutsideBraidFixingMedium.
Methods
- MediaLibrary collection has method AddToModel(string).
- MediaLibrary collection has method AddToModelWithLabel(string, string).

Property List

Colour: The medium colour. (Read/Write string)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

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

Colour

The medium colour.

Type: string
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

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.