SphericalModesDataManuallySpecified
A spherical modes data using manual specifications.
Example
app = cf.GetApplication() project = app:NewProject() -- Created 'SphericalModesDataManuallySpecified' -- from a set of default properties properties = cf.SphericalModesDataManuallySpecified.GetDefaultProperties() properties.ModeIndices[1].SphericalMJ = "1" properties.ModeIndices[1].SphericalMagnitude = "1" properties.ModeIndices[1].SphericalN = "10" properties.ModeIndices[1].SphericalPhase = "13" SphericalModesData1 = project.FieldDataList: AddSphericalModesDataManuallySpecified(properties)
Inheritance
The SphericalModesDataManuallySpecified object is derived from the FieldData object.
Property List
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The field data workplane. (Read only LocalWorkplane)
- PropagationDirection
- Select the direction of propagation for the spherical mode. (Read/Write SphericalModesDataPropagationDirectionMethodEnum)
- Type
- The object type string. (Read only string)
Collection List
- ModeIndices
- The collection of spherical modes data defined manually. (SphericalModeOptionsCollection of SphericalModeOptions.)
Method List
- Delete ()
- Delete the field data definition.
- Duplicate ()
- Duplicate field data definition. (Returns a FieldData 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 table)
- 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
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalWorkplane
- The field data workplane.
- Type
- LocalWorkplane
- Access
- Read only
- PropagationDirection
- Select the direction of propagation for the spherical mode.
- Type
- SphericalModesDataPropagationDirectionMethodEnum
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- ModeIndices
- The collection of spherical modes data defined manually.
Method Details
- Delete ()
- Delete the field data definition.
- Duplicate ()
- Duplicate field data definition.
- Return
- FieldData
- The duplicated field data definition.
- 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 properties table.
- SetProperties (properties table)
- 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(table)
- 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
- The default properties table.