Dielectric
A dielectric medium.
Example
app = cf.GetApplication() project = app:NewProject() -- Create a dielectric medium dielectric = project.Media:AddDielectric(2.16, 0.001, 1000) -- Change the colour to Cyan dielectric.Colour = "#00FFFF"
Inheritance
The Dielectric object is derived from the Medium object.
Property List
- Colour
- The medium colour. (Read/Write Colour)
- DielectricModelling
- The medium dielectric modelling properties. (Read only DielectricModelling)
- Filename
- The file describing the medium properties in XML format. (Read/Write string)
- Label
- The object label. (Read/Write string)
- MagneticModelling
- The medium magnetic modelling properties. (Read only MagneticModelling)
- MassDensity
- Medium's mass density (kg/m^3). (Read/Write Expression)
- SourceDefinitionMethod
- Specifies the method used for defining the medium. (Read/Write MediumSourceDefinitionMethodEnum)
- Suspect
- Indicates whether the medium is suspect. (Read only boolean)
- Type
- The object type string. (Read only string)
Method List
- AddToLibrary ()
- Add the medium to the media library.
- Delete ()
- Delete the medium.
- 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.)
- SetNotSuspect ()
- Reset the suspect setting on the medium.
- SetProperties (properties table)
- 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
- Colour
- Access
- Read/Write
- DielectricModelling
- The medium dielectric modelling properties.
- Type
- DielectricModelling
- Access
- Read only
- Filename
- The file describing the medium properties in XML format.
- Type
- string
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- MagneticModelling
- The medium magnetic modelling properties.
- Type
- MagneticModelling
- Access
- Read only
- MassDensity
- Medium's mass density (kg/m^3).
- Type
- Expression
- Access
- Read/Write
- SourceDefinitionMethod
- Specifies the method used for defining the medium.
- Type
- MediumSourceDefinitionMethodEnum
- Access
- Read/Write
- Suspect
- Indicates whether the medium is suspect.
- Type
- boolean
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- AddToLibrary ()
- Add the medium to the media library.
- Delete ()
- Delete the medium.
- 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 properties table.
- SetNotSuspect ()
- Reset the suspect setting on the medium.
- SetProperties (properties table)
- 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(table)
- 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
- The default properties table.