NearFieldDataFileStructure
A near field data file structure specification.
Example
app = cf.GetApplication() project = app:NewProject() -- Created new NearFieldFileStructure from a set of default properties properties = cf.NearFieldDataFileStructure.GetDefaultProperties() properties.CartesianStructure.Height = "2" properties.CartesianStructure.Width = "2" properties.CartesianStructure.UPoints = "11" properties.CartesianStructure.VPoints = "11" properties.EFieldFilename = [[EFieldFileName]] properties.HFieldFilename = [[HFieldFileName]] nearFieldData = project.FieldDataList:AddNearFieldDataFileStructure(properties)
Inheritance
The NearFieldDataFileStructure object is derived from the FieldData object.
Property List
- CartesianStructure
- The near field data cartesian source definition. Only valid if CoordinateType is Cartesian. (Read only CartesianStructure)
- CoordinateType
- Select the coordinate type. (Read/Write NearFieldDataCoordinateTypeEnum)
- CylindricalStructure
- The near field data cartesian source definition. Only valid if CoordinateType is Cylindrical. (Read only CylindricalStructure)
- DataType
- Select the data type. (Read/Write NearFieldDataFileStructureDataTypeEnum)
- EFieldFilename
- Import file containing the E-Field definition. (Read/Write string)
- HFieldFilename
- Import directory containing H-Field definition. (Read/Write string)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The field data workplane. (Read only LocalWorkplane)
- ReadFromLine
- Which line to start reading from. (Read/Write Expression)
- SampleEdgesEnabled
- Includes samples on edges of face if enabled. (Read/Write boolean)
- SourceType
- Select the source type. (Read/Write NearFieldDataSourceTypeEnum)
- SphericalStructure
- The near field data cartesian source definition. Only valid if CoordinateType is Spherical. (Read only SphericalStructure)
- Type
- The object type string. (Read only string)
- 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
- CartesianStructure
- The near field data cartesian source definition. Only valid if CoordinateType is Cartesian.
- Type
- CartesianStructure
- Access
- Read only
- CoordinateType
- Select the coordinate type.
- Type
- NearFieldDataCoordinateTypeEnum
- Access
- Read/Write
- CylindricalStructure
- The near field data cartesian source definition. Only valid if CoordinateType is Cylindrical.
- Type
- CylindricalStructure
- Access
- Read only
- DataType
- Select the data type.
- Type
- NearFieldDataFileStructureDataTypeEnum
- Access
- Read/Write
- EFieldFilename
- Import file containing the E-Field definition.
- Type
- string
- Access
- Read/Write
- HFieldFilename
- Import directory containing H-Field definition.
- Type
- string
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalWorkplane
- The field data workplane.
- Type
- LocalWorkplane
- Access
- Read only
- ReadFromLine
- Which line to start reading from.
- Type
- Expression
- Access
- Read/Write
- SampleEdgesEnabled
- Includes samples on edges of face if enabled.
- Type
- boolean
- Access
- Read/Write
- SourceType
- Select the source type.
- Type
- NearFieldDataSourceTypeEnum
- Access
- Read/Write
- SphericalStructure
- The near field data cartesian source definition. Only valid if CoordinateType is Spherical.
- Type
- SphericalStructure
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
- 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.