SphericalModesData
A spherical modes data using full file import.
Example
app = cf.GetApplication() project = app:NewProject() -- Import 'SphericalModesData' from previously a exported 'FarField' sphericalModesData = project.FieldDataList: AddSphericalModesDataFullImport([[SphericalModesData.sph]])
Inheritance
The SphericalModesData object is derived from the FieldData object.
Property List
- DataBlockNumber
- The data block that is first read from. (Read/Write Expression)
- Filename
- Import file containing the spherical modes data. (Read/Write string)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The field data workplane. (Read only LocalWorkplane)
- Type
- The object type string. (Read only string)
- UseAllDataBlocks
- Specifies if all data blocks should be read. (Read/Write boolean)
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
- DataBlockNumber
- The data block that is first read from.
- Type
- Expression
- Access
- Read/Write
- Filename
- Import file containing the spherical modes data.
- Type
- string
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalWorkplane
- The field data workplane.
- Type
- LocalWorkplane
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
- UseAllDataBlocks
- Specifies if all data blocks should be read.
- Type
- boolean
- Access
- Read/Write
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.