CableRibbonCrossSection
A ribbon cross section.
Example
application = cf.Application.GetInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) -- Add a ribbon cross section ribbon = project.Definitions.Cables.CrossSections:AddRibbonWithInsulation( project.Definitions.Media.PerfectElectricConductor, 0.001, project.Definitions.Media.Dielectric["Insulation"], 0.0005, 5, 0.003) -- Adjust the number of cores to 3 ribbon.CoreCount = 3
Inheritance
The CableRibbonCrossSection object is derived from the CableCrossSection object.
Usage locations
The CableRibbonCrossSection object can be accessed from the following locations:
- Methods
- CableCrossSectionCollection collection has method AddRibbon(table).
- CableCrossSectionCollection collection has method AddRibbon(Medium, Expression, Expression, Expression).
- CableCrossSectionCollection collection has method AddRibbonWithInsulation(Medium, Expression, Medium, Expression, Expression, Expression).
Property List
- CablePerUnitLengthAccuracy
- Select a higher accuracy when calculating cable per-unit-length parameters. (Read/Write CablePerUnitLengthAccuracyEnum)
- CoreCount
- The number of cores. (Read/Write ParametricExpression)
- CoreMedium
- The conductor core medium. (Read/Write Medium)
- CoreRadius
- The core radius. (Read/Write ParametricExpression)
- CoreSpacing
- The core spacing. (Read/Write ParametricExpression)
- Insulated
- True if the conductor is insulated. (Read/Write boolean)
- InsulationMedium
- The conductor insulation medium. Only applies if the 'Insulated' property is true. (Read/Write Medium)
- InsulationThickness
- The insulation thickness. Only applies if the 'Insulated' property is true. (Read/Write ParametricExpression)
- Label
- The object label. (Read/Write string)
- 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
- CablePerUnitLengthAccuracy
- Select a higher accuracy when calculating cable per-unit-length parameters.
- Type
- CablePerUnitLengthAccuracyEnum
- Access
- Read/Write
- CoreCount
- The number of cores.
- Type
- ParametricExpression
- Access
- Read/Write
- CoreMedium
- The conductor core medium.
- Type
- Medium
- Access
- Read/Write
- CoreRadius
- The core radius.
- Type
- ParametricExpression
- Access
- Read/Write
- CoreSpacing
- The core spacing.
- Type
- ParametricExpression
- Access
- Read/Write
- Insulated
- True if the conductor is insulated.
- Type
- boolean
- Access
- Read/Write
- InsulationMedium
- The conductor insulation medium. Only applies if the 'Insulated' property is true.
- Type
- Medium
- Access
- Read/Write
- InsulationThickness
- The insulation thickness. Only applies if the 'Insulated' property is true.
- Type
- ParametricExpression
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- 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.