NearFieldDataFullImport
An aperture data using full file import.
Example
app = cf.GetApplication() project = app:NewProject() -- Import 'NearFieldDataFullImport' from previously a exported 'NearField' nearFieldData = project.FieldDataList: AddNearFieldDataFullImport([[NearFieldData.nfd]])
Inheritance
The NearFieldDataFullImport object is derived from the FieldData object.
Property List
- DataBlockNumber
- The data block that is first read from. (Read/Write Expression)
- DataType
- Select the data type. (Read/Write NearFieldDataFullImportDataTypeEnum)
- Directory
- Import directory containing aperture data. (Read/Write string)
- EFieldFilename
- Import file containing the E-Field aperture data. Only applicable when the source type is LoadEfe or LoadEfeHfe. (Read/Write string)
- Filename
- Import file containing the aperture data. (Read/Write string)
- HFieldFilename
- Import file containing the H-Field aperture data. Only applicable when the source type is LoadHfe or LoadEfeHfe. (Read/Write string)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The field data workplane. (Read only LocalWorkplane)
- SourceType
- Select the source file type. Only applicable when the data type is CartesianBoundary. (Read/Write NearFieldDataSourceTypeEnum)
- Type
- The object type string. (Read only string)
- UseAllBlocks
- Controls whether to read all blocks from the file or only the specified one. (Read/Write boolean)
- ValidityRegionsSwapped
- Consider the fields to be valid on the inside of the region when checked. (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
- DataType
- Select the data type.
- Type
- NearFieldDataFullImportDataTypeEnum
- Access
- Read/Write
- Directory
- Import directory containing aperture data.
- Type
- string
- Access
- Read/Write
- EFieldFilename
- Import file containing the E-Field aperture data. Only applicable when the source type is LoadEfe or LoadEfeHfe.
- Type
- string
- Access
- Read/Write
- Filename
- Import file containing the aperture data.
- Type
- string
- Access
- Read/Write
- HFieldFilename
- Import file containing the H-Field aperture data. Only applicable when the source type is LoadHfe or LoadEfeHfe.
- Type
- string
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalWorkplane
- The field data workplane.
- Type
- LocalWorkplane
- Access
- Read only
- SourceType
- Select the source file type. Only applicable when the data type is CartesianBoundary.
- Type
- NearFieldDataSourceTypeEnum
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- UseAllBlocks
- Controls whether to read all blocks from the file or only the specified one.
- Type
- boolean
- Access
- Read/Write
- ValidityRegionsSwapped
- Consider the fields to be valid on the inside of the region when checked.
- 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.