# NearFieldDataFileStructure

A near field data file structure specification.

## Example

application = cf.Application.GetInstance()
project = application: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.Definitions.FieldDataList:AddNearFieldDataFileStructure(properties)

## Inheritance

The NearFieldDataFileStructure object is derived from the FieldData object.

## Usage locations

The NearFieldDataFileStructure object can be accessed from the following locations:

## Property List

CartesianStructure
The near field data cartesian source definition. Only valid if CoordinateType is Cartesian. (Read/Write CartesianStructure)
CoordinateType
Select the coordinate type. (Read/Write NearFieldDataCoordinateTypeEnum)
CylindricalStructure
The near field data cartesian source definition. Only valid if CoordinateType is Cylindrical. (Read/Write CylindricalStructure)
DataBlockNumber
DataType
Select the data type. (Read/Write NearFieldDataFileStructureDataTypeEnum)
EFieldFilename
Import file containing the E-Field definition. (Read/Write FileReference)
HFieldFilename
Import directory containing H-Field definition. (Read/Write FileReference)
Label
LocalWorkplane
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/Write 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)

## Collection List

Transforms
The collection of transforms on the operator. (TransformCollection of Transform.)

## Method List

CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties. (Returns a Object object.)
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry. (Returns a List of Object object.)
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry. (Returns a List of Object object.)
Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity. (Returns a Object 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 Object)
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
CoordinateType
Select the coordinate type.
Type
NearFieldDataCoordinateTypeEnum
Access
CylindricalStructure
The near field data cartesian source definition. Only valid if CoordinateType is Cylindrical.
Type
CylindricalStructure
Access
DataBlockNumber
The data block that is first read from.
Type
ParametricExpression
Access
DataType
Select the data type.
Type
NearFieldDataFileStructureDataTypeEnum
Access
EFieldFilename
Import file containing the E-Field definition.
Type
FileReference
Access
HFieldFilename
Import directory containing H-Field definition.
Type
FileReference
Access
Label
The object label.
Type
string
Access
LocalWorkplane
The source workplane.
Type
LocalWorkplane
Access
Which line to start reading from.
Type
ParametricExpression
Access
SampleEdgesEnabled
Includes samples on edges of face if enabled.
Type
boolean
Access
SourceType
Select the source type.
Type
NearFieldDataSourceTypeEnum
Access
SphericalStructure
The near field data cartesian source definition. Only valid if CoordinateType is Spherical.
Type
SphericalStructure
Access
Type
The object type string.
Type
string
Access
ValidityRegionsSwapped
Consider the fields to be valid on the inside of the region when checked.
Type
boolean
Access

## Collection Details

Transforms
The collection of transforms on the operator.
Type
TransformCollection

## Method Details

CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the mirror transform.
Return
Object
The mirrored geometry.
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the rotate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of rotated geometry.
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry.
Input Parameters
origin(Point)
The coordinates of the origin of the rotation.
rotationaxis(Vector)
The axis of rotation.
angle(number)
The angle of rotation (degrees).
count(number)
The number of copies.
Return
List of Object
The list of rotated geometry.
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the translate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of translated geometry.
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry.
Input Parameters
from(Point)
Translate from coordinate.
to(Point)
Translate to coordinate.
count(number)
The number of copies.
Return
List of Object
The list of translated geometry.
Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity.
Return
Object
The new (duplicated) entity.
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 table defining the properties.
SetProperties (properties Object)
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(Object)
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
A table containing the default properties.