MetalCollection
A collection of metallic media.
Example
application = cf.Application.getInstance() project = application:NewProject() -- Create metallic media metal = project.Definitions.Media.Metallic:AddMetal()
Inheritance
The MetalCollection object is derived from the Object object.
Usage locations
The MetalCollection object can be accessed from the following locations:
Property List
Method List
- AddMetal (properties table)
- Create a dielectric medium. (Returns a Metal object.)
- AddMetal (relativepermeability Expression, losstangent Expression, conductivity Expression)
- Creates a new metallic medium. (Returns a Metal object.)
- AddMetal ()
- Creates a new metallic medium. (Returns a Metal object.)
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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 Metal for the given index in the collection. (Returns a Metal object.)
- Item (label string)
- Returns the Metal for the given label in the collection. (Returns a Metal object.)
- Items ()
- Returns a table of Metal items. (Returns a UnsupportedType(List of Metal) 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
Method Details
- AddMetal (properties table)
- Create a dielectric medium.
- AddMetal (relativepermeability Expression, losstangent Expression, conductivity Expression)
- Creates a new metallic medium.
- Input Parameters
- relativepermeability(Expression)
- The frequency independent relative permeability.
- losstangent(Expression)
- The frequency independent magnetic loss tangent.
- conductivity(Expression)
- The frequency independent conductivity (S/m).
- Return
- Metal
- The metallic medium.
- AddMetal ()
- Creates a new metallic medium.
- Return
- Metal
- The metallic medium.
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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 Metal for the given index in the collection.
- Item (label string)
- Returns the Metal for the given label in the collection.
- Items ()
- Returns a table of Metal items.
- Return
- UnsupportedType(List of Metal)
- 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.