WindscreenCollection
A collection of windscreens.
Example
application = cf.Application.getInstance() project = application:NewProject() -- Create dielectric to be used for the windscreens dielectric = project.Definitions.Media.Dielectric:AddDielectric() layeredDielectric1 = project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1}, {dielectric}) layeredDielectric2 = project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.3}, {dielectric}) -- Create some windscreen media windscreen1 = project.Definitions.Media.Windscreen:AddWindscreen(layeredDielectric1, 0.1) windscreen2 = project.Definitions.Media.Windscreen:AddWindscreen(layeredDielectric2, 0.4)
Inheritance
The WindscreenCollection object is derived from the Object object.
Usage locations
The WindscreenCollection object can be accessed from the following locations:
- Collection lists
- Media object has collection Windscreen.
Property List
Method List
- AddWindscreen (properties table)
- Create a windscreen medium from a table defining the properties. (Returns a Windscreen object.)
- AddWindscreen (medium LayeredIsotropicDielectric, offset Expression)
- Create a windscreen medium. (Returns a Windscreen 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.)
- 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
- AddWindscreen (properties table)
- Create a windscreen medium from a table defining the properties.
- Input Parameters
- properties(table)
- A table of properties defining the new windscreen medium.
- Return
- Windscreen
- The windscreen medium.
- AddWindscreen (medium LayeredIsotropicDielectric, offset Expression)
- Create a windscreen medium.
- Input Parameters
- medium(LayeredIsotropicDielectric)
- The layered dielectric contained in the windscreen layers.
- offset(Expression)
- The distance (in the model unit) from the windscreen curvature reference to the top of layer 1.
- Return
- Windscreen
- The windscreen 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.
- 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.