SphericalModeOptionsCollection
A collection of spherical modes data properties for a manual spherical modes data.
Example
app = cf.GetApplication() project = app:NewProject() properties = cf.SphericalModesDataManuallySpecified.GetDefaultProperties() properties.ModeIndices[1].SphericalMJ = "1" properties.ModeIndices[1].SphericalMagnitude = "3" properties.ModeIndices[1].SphericalN = "2" properties.ModeIndices[1].SphericalPhase = "4" fieldData = project.FieldDataList:AddSphericalModesDataManuallySpecified(properties) -- Use the SphericalModeOptionsCollection to modify, add and remove a spherical mode sphericalModeOptionsCollection = fieldData.ModeIndices sphericalModeOptionsCollection:Add(cf.Enums.SphericalModesDataIndexSchemeMethodEnum.Normal, cf.Enums.SphericalModesDataTeTmTypeMethodEnum.TE, 1, 2, 3, 4) sphericalModeOptionsCollection:Modify(2, cf.Enums.SphericalModesDataIndexSchemeMethodEnum.Normal, cf.Enums.SphericalModesDataTeTmTypeMethodEnum.TE, 2, 3, 4, 5) sphericalModeOptionsCollection:Remove(1)
Usage locations (collections)
The following objects contain the SphericalModeOptionsCollection collection:
Property List
Method List
- Add (indexschemetype Expression, tetmtype Expression, sphericalmj Expression, sphericaln Expression, sphericalmagnitude Expression, sphericalphase Expression)
- Add manual data for a specific spherical mode.
- Item (index number)
- Returns the SphericalModeOptions at the given index. (Returns a SphericalModeOptions object.)
- Modify (index number, indexschemetype Expression, tetmtype Expression, sphericalmj Expression, sphericaln Expression, sphericalmagnitude Expression, sphericalphase Expression)
- Modify a manual data from the spherical modes data.
- Remove (index number)
- Remove a manual data from the spherical modes data.
Index List
- [number]
- Returns the SphericalModeOptions at the given index in the collection. (Read SphericalModeOptions)
Property Details
- Count
- The number of SphericalModeOptions items in the collection.
- Type
- number
- Access
- Read only
Method Details
- Add (indexschemetype Expression, tetmtype Expression, sphericalmj Expression, sphericaln Expression, sphericalmagnitude Expression, sphericalphase Expression)
- Add manual data for a specific spherical mode.
- Input Parameters
- indexschemetype(Expression)
- Index scheme for this specific spherical mode.
- tetmtype(Expression)
- Select either the TE or TM mode for this specific spherical mode.
- sphericalmj(Expression)
- The M mode index which is in the azimuth direction for this specific spherical mode.
- sphericaln(Expression)
- The N mode index which is in radial direction for this specific spherical mode.
- sphericalmagnitude(Expression)
- Absolute value of the complex amplitude of this specific spherical mode.
- sphericalphase(Expression)
- The phase of the complex amplitude of this spherical mode in degrees.
- Item (index number)
- Returns the SphericalModeOptions at the given index.
- Input Parameters
- index(number)
- The index of the SphericalModeOptions.
- Return
- SphericalModeOptions
- The SphericalModeOptions at the given index.
- Modify (index number, indexschemetype Expression, tetmtype Expression, sphericalmj Expression, sphericaln Expression, sphericalmagnitude Expression, sphericalphase Expression)
- Modify a manual data from the spherical modes data.
- Input Parameters
- index(number)
- An index representing a specific entry.
- indexschemetype(Expression)
- Index scheme for this specific spherical mode.
- tetmtype(Expression)
- Select either the TE or TM mode for this specific spherical mode.
- sphericalmj(Expression)
- The N mode index which is in radial direction for this specific spherical mode.
- sphericaln(Expression)
- The N mode index which is in radial direction for this specific spherical mode.
- sphericalmagnitude(Expression)
- Absolute value of the complex amplitude of this specific spherical mode.
- sphericalphase(Expression)
- The phase of the complex amplitude of this spherical mode in degrees.
- Remove (index number)
- Remove a manual data from the spherical modes data.
- Input Parameters
- index(number)
- The point index.