Windscreen
A windscreen medium.
Example
application = cf.Application.getInstance() project = application:NewProject() dielectric = project.Definitions.Media.Dielectric:AddDielectric() layeredDielectric = project.Definitions.Media.LayeredDielectric:AddLayeredDielectric({0.1},{dielectric}) -- Create a windscreen medium windscreenMedium = project.Definitions.Media.Windscreen:AddWindscreen(layeredDielectric,0.1) -- Change the offset of the windscreen medium windscreenMedium.Offset = 0.2
Inheritance
The Windscreen object is derived from the Medium object.
Usage locations
The Windscreen object can be accessed from the following locations:
- Properties
- WindscreenSolutionMethod object has property Medium.
- Methods
- WindscreenCollection collection has method AddWindscreen(table).
- WindscreenCollection collection has method AddWindscreen(LayeredIsotropicDielectric, Expression).
- WindscreenCollection collection has method Item(number).
- WindscreenCollection collection has method Item(string).
Property List
- Colour
- The medium colour. (Read/Write string)
- Label
- The object label. (Read/Write string)
- LayerDefinition
- The layered dielectric contained in the windscreen layers. (Read/Write LayeredIsotropicDielectric)
- Offset
- The distance (in the model unit) from the windscreen curvature reference to the top of layer 1. (Read/Write ParametricExpression)
- 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
- LayerDefinition
- The layered dielectric contained in the windscreen layers.
- Type
- LayeredIsotropicDielectric
- Access
- Read/Write
- Offset
- The distance (in the model unit) from the windscreen curvature reference to the top of layer 1.
- Type
- ParametricExpression
- Access
- Read/Write
- 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.