LayeredIsotropicDielectric
A layered isotropic dielectric medium.
Example
application = cf.Application.GetInstance() project = application:NewProject() dielectric = project.Definitions.Media.Dielectric:AddDielectric() -- Create a layered dielectric medium project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1},{dielectric})
Inheritance
The LayeredIsotropicDielectric object is derived from the LayeredDielectric object.
Usage locations
The LayeredIsotropicDielectric object can be accessed from the following locations:
- Properties
- Windscreen object has property LayerDefinition.
- Methods
- LayeredDielectricCollection collection has method AddLayeredDielectric(table).
- LayeredDielectricCollection collection has method AddLayeredDielectric(ExpressionList, List of Dielectric).
Property List
- Colour
- The medium colour. (Read/Write string)
- Label
- The object label. (Read/Write string)
- Layers
- The collection of layers for the layered anisotropic dielectric medium. (Read/Write IsotropicDielectricLayersList)
- Thickness
- The thickness (in the model unit) of the layer. (Read only number)
- 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
- Layers
- The collection of layers for the layered anisotropic dielectric medium.
- Type
- IsotropicDielectricLayersList
- Access
- Read/Write
- Thickness
- The thickness (in the model unit) of the layer.
- Type
- number
- Access
- Read only
- 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.