GroundPlaneMedium
The finite ground plane medium.
Example
application = cf.Application.GetInstance() project = application:NewProject() dielectric = project.Definitions.Media.Dielectric:AddDielectric() project.Contents.SolutionSettings.GroundPlane.DefinitionMethod = cf.Enums.GroundPlaneDefinitionMethodEnum.MultilayerSubstrate layer = project.Contents.SolutionSettings.GroundPlane.Layers:Append() layer.Medium = dielectric layer.GroundBottom = cf.Enums.GroundBottomTypeEnum.None layer.Thickness = 0.1 -- Retrieve the ground plane medium groundPlaneMedium = project.Definitions.Media.GroundPlaneMedium
Inheritance
The GroundPlaneMedium object is derived from the Dielectric object.
Usage locations
The GroundPlaneMedium object can be accessed from the following locations:
- Properties
- Media object has property GroundPlaneMedium.
Property List
- Colour
- The medium colour. (Read/Write string)
- DielectricModelling
- The medium dielectric modelling properties. (Read/Write DielectricModelling)
- Filename
- The file describing the medium properties in XML format. (Read/Write FileReference)
- Label
- The object label. (Read/Write string)
- MagneticModelling
- The medium magnetic modelling properties. (Read/Write MagneticModelling)
- MassDensity
- Medium's mass density (kg/m^3). (Read/Write ParametricExpression)
- SourceDefinitionMethod
- Specifies the method used for defining the medium. (Read/Write MediumSourceDefinitionMethodEnum)
- 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
- DielectricModelling
- The medium dielectric modelling properties.
- Type
- DielectricModelling
- Access
- Read/Write
- Filename
- The file describing the medium properties in XML format.
- Type
- FileReference
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- MagneticModelling
- The medium magnetic modelling properties.
- Type
- MagneticModelling
- Access
- Read/Write
- MassDensity
- Medium's mass density (kg/m^3).
- Type
- ParametricExpression
- Access
- Read/Write
- SourceDefinitionMethod
- Specifies the method used for defining the medium.
- Type
- MediumSourceDefinitionMethodEnum
- 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.