LayeredDielectricCollection

A collection of layered dielectric media.

Example

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

    -- Create the dielectric media
dielectric1 = project.Definitions.Media.Dielectric:AddDielectric()
dielectric2 = project.Definitions.Media.Dielectric:AddDielectric()
dielectric3 = project.Definitions.Media.Dielectric:AddDielectric()

    -- Create the layered dielectric medium
layered = project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1, 0.1, 0.1}, {dielectric1, dielectric2, dielectric3})

Inheritance

The LayeredDielectricCollection object is derived from the Object object.

Usage locations

The LayeredDielectricCollection object can be accessed from the following locations:

Property List

Count
The number of LayeredDielectric items in the collection. (Read only number)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

AddLayeredAnisotropicDielectric (properties table)
Create a layered dielectric (anisotropic) medium from a table defining the properties. (Returns a LayeredAnisotropicDielectric object.)
AddLayeredAnisotropicDielectric (thicknesslist ExpressionList, directionlist ExpressionList, principlemediumlist List of Dielectric, orthogonalmediumlist List of Dielectric)
Create a layered dielectric (anisotropic) medium. (Returns a LayeredAnisotropicDielectric object.)
AddLayeredDielectric (properties table)
Create a layered dielectric (isotropic) medium from a table defining the properties. (Returns a LayeredIsotropicDielectric object.)
AddLayeredDielectric (thicknesslist ExpressionList, mediumlist List of Dielectric)
Create a layered dielectric (isotropic) medium. (Returns a LayeredIsotropicDielectric object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
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.)
Item (index number)
Returns the LayeredDielectric for the given index in the collection. (Returns a LayeredDielectric object.)
Item (label string)
Returns the LayeredDielectric for the given label in the collection. (Returns a LayeredDielectric object.)
Items ()
Returns a table of LayeredDielectric items. (Returns a UnsupportedType(List of LayeredDielectric) 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.
UniqueName (label string)
Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a string object.)

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Count
The number of LayeredDielectric items in the collection.
Type
number
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

AddLayeredAnisotropicDielectric (properties table)
Create a layered dielectric (anisotropic) medium from a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the new layered dielectric medium.
Return
LayeredAnisotropicDielectric
The layered anisotropic dielectric medium.
AddLayeredAnisotropicDielectric (thicknesslist ExpressionList, directionlist ExpressionList, principlemediumlist List of Dielectric, orthogonalmediumlist List of Dielectric)
Create a layered dielectric (anisotropic) medium.
Input Parameters
thicknesslist(ExpressionList)
The list of layer thicknesses (in the model unit).
directionlist(ExpressionList)
The list of angles (in degrees) from which the principle directions is obtained.
principlemediumlist(List of Dielectric)
The list of layer dielectric media in the principle direction.
orthogonalmediumlist(List of Dielectric)
The list of layer dielectric media in the orthogonal direction.
Return
LayeredAnisotropicDielectric
The layered anisotropic dielectric medium.
AddLayeredDielectric (properties table)
Create a layered dielectric (isotropic) medium from a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the new layered dielectric medium.
Return
LayeredIsotropicDielectric
The layered isotropic dielectric medium.
AddLayeredDielectric (thicknesslist ExpressionList, mediumlist List of Dielectric)
Create a layered dielectric (isotropic) medium.
Input Parameters
thicknesslist(ExpressionList)
The list of layer thicknesses (in the model unit).
mediumlist(List of Dielectric)
The list of layer dielectric media.
Return
LayeredIsotropicDielectric
The layered isotropic dielectric medium.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the item.
Return
boolean
The success of the check.
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.
Item (index number)
Returns the LayeredDielectric for the given index in the collection.
Input Parameters
index(number)
The index of the LayeredDielectric.
Return
LayeredDielectric
The item in the collection
Item (label string)
Returns the LayeredDielectric for the given label in the collection.
Input Parameters
label(string)
The label of the LayeredDielectric.
Return
LayeredDielectric
The item in the collection
Items ()
Returns a table of LayeredDielectric items.
Return
UnsupportedType(List of LayeredDielectric)
The list of items in the collection
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.
UniqueName (label string)
Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
string
The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.