DielectricCollection

A collection of dielectric media.

Example

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

    -- Create the dielectric medium
dielectric = project.Definitions.Media.Dielectric:AddDielectric()

Inheritance

The DielectricCollection object is derived from the Object object.

Usage locations

The DielectricCollection object can be accessed from the following locations:

Property List

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

Method List

AddDielectric (properties table)
Create a dielectric medium from a table defining the properties. (Returns a Dielectric object.)
AddDielectric (relativepermittivity Expression, losstangent Expression, massdensity Expression)
Create a dielectric medium. (Returns a Dielectric object.)
AddDielectric ()
Create a dielectric medium. (Returns a Dielectric 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 Dielectric for the given index in the collection. (Returns a Dielectric object.)
Item (label string)
Returns the Dielectric for the given label in the collection. (Returns a Dielectric object.)
Items ()
Returns a table of Dielectric items. (Returns a UnsupportedType(List of Dielectric) 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

Count
The number of Dielectric 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

AddDielectric (properties table)
Create a dielectric medium from a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the new dielectric medium.
Return
Dielectric
The dielectric medium.
AddDielectric (relativepermittivity Expression, losstangent Expression, massdensity Expression)
Create a dielectric medium.
Input Parameters
relativepermittivity(Expression)
The frequency independent dielectric relative permittivity.
losstangent(Expression)
The frequency independent dielectric loss tangent.
massdensity(Expression)
The mass density (kg/m^3).
Return
Dielectric
The dielectric medium.
AddDielectric ()
Create a dielectric medium.
Return
Dielectric
The dielectric medium.
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 Dielectric for the given index in the collection.
Input Parameters
index(number)
The index of the Dielectric.
Return
Dielectric
The item in the collection
Item (label string)
Returns the Dielectric for the given label in the collection.
Input Parameters
label(string)
The label of the Dielectric.
Return
Dielectric
The item in the collection
Items ()
Returns a table of Dielectric items.
Return
UnsupportedType(List of Dielectric)
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.

Static Function Details

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