# FieldDataCollection

A collection of field data.

## Example

app = cf.GetApplication()
project = app:NewProject()

-- Retrieve the project's 'FieldDataCollection'

fieldDataCollection = project.FieldDataList

-- Add a 'FarFieldData' to the collection

-- Query the number of FieldData entries in the collection

-- Retrieve the first 'FieldData' from the collection

fieldData = fieldDataCollection[1]


## Usage locations (collections)

The following objects contain the FieldDataCollection collection:

## Property List

Count
The number of FieldData items in the collection. (Read only number)
Type
The object type string. (Read only string)

## Method List

Create a far field data by importing from a known file format. (Returns a FarFieldData object.)
AddFarFieldData (filename string, numberthetapoints number, numberphipoints number)
Create a far field data by importing from a file format with an unknown structure where the structure is given as part of the data. (Returns a FarFieldData object.)
Create a far field data by importing from a known file format. (Returns a FarFieldData object.)
Create a near field data by importing from a known file format. (Returns a NearFieldDataFileStructure object.)
Create a near field data by importing from a known file format. (Returns a NearFieldDataFullImport object.)
Create a near field data by importing from a known file format. (Returns a NearFieldDataFullImport object.)
Create PCB current data. (Returns a PCBCurrentData object.)
Create PCB current data by specifying a file defining the PCB and currents. (Returns a PCBCurrentData object.)
Create solution coefficient data. (Returns a SolutionCoefficientData object.)
Create solution coefficient data by specifying a file defining the coefficients. (Returns a SolutionCoefficientData object.)
Create a spherical modes data. (Returns a SphericalModesData object.)
Create a spherical modes data by importing the modes from a known file format. (Returns a SphericalModesData object.)
Create a spherical modes data by specifying the individual complex weightings for each spherical mode. (Returns a SphericalModesDataManuallySpecified object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the FieldData at the given index. (Returns a FieldData object.)
Item (label string)
Returns the FieldData with the given label. (Returns a FieldData object.)
Items ()
Returns a table of FieldData. (Returns a List of FieldData object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

## Index List

[number]
Returns the FieldData at the given index in the collection. (Read FieldData)
[string]
Returns the FieldData with the given name in the collection. (Read FieldData)

## Property Details

Count
The number of FieldData items in the collection.
Type
number
Access
Type
The object type string.
Type
string
Access

## Method Details

Create a far field data by importing from a known file format.
Input Parameters
filename(string)
Import file containing the far field data.
Return
FarFieldData
The far field data.
AddFarFieldData (filename string, numberthetapoints number, numberphipoints number)
Create a far field data by importing from a file format with an unknown structure where the structure is given as part of the data.
Input Parameters
filename(string)
Import file containing the far field data.
numberthetapoints(number)
The number of theta points used for the data.
numberphipoints(number)
The number of phi points used for the data.
Return
FarFieldData
The far field data.
Create a far field data by importing from a known file format.
Input Parameters
properties(table)
A table of properties defining the new far field data.
Return
FarFieldData
The far field data.
Create a near field data by importing from a known file format.
Input Parameters
properties(table)
A table of properties defining the new near field data.
Return
NearFieldDataFileStructure
The near field data.
Create a near field data by importing from a known file format.
Input Parameters
filename(string)
Import file containing the aperture data.
Return
NearFieldDataFullImport
The near field data.
Create a near field data by importing from a known file format.
Input Parameters
properties(table)
A table of properties defining the new near field data.
Return
NearFieldDataFullImport
The near field data.
Create PCB current data.
Input Parameters
properties(table)
A table of properties defining the new PCB current data.
Return
PCBCurrentData
The PCB current data.
Create PCB current data by specifying a file defining the PCB and currents.
Input Parameters
filename(string)
Import file containing the PCB current data.
Return
PCBCurrentData
The PCB current data.
Create solution coefficient data.
Input Parameters
properties(table)
A table of properties defining the new solution coefficient data.
Return
SolutionCoefficientData
The solution coefficient data.
Create solution coefficient data by specifying a file defining the coefficients.
Input Parameters
filename(string)
Import file containing the solution coefficient data.
Return
SolutionCoefficientData
The solution coefficient data.
Create a spherical modes data.
Input Parameters
properties(table)
A table of properties defining the new spherical modes data.
Return
SphericalModesData
The spherical modes data.
Create a spherical modes data by importing the modes from a known file format.
Input Parameters
filename(string)
Import file containing the spherical modes data.
Return
SphericalModesData
The spherical modes full import data.
Create a spherical modes data by specifying the individual complex weightings for each spherical mode.
Input Parameters
properties(table)
A table of properties defining the new spherical modes data.
Return
SphericalModesDataManuallySpecified
The spherical modes data.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the FieldData.
Return
boolean
The success of the check.
Item (index number)
Returns the FieldData at the given index.
Input Parameters
index(number)
The index of the FieldData.
Return
FieldData
The FieldData at the given index.
Item (label string)
Returns the FieldData with the given label.
Input Parameters
label(string)
The label of the FieldData.
Return
FieldData
The FieldData with the given label.
Items ()
Returns a table of FieldData.
Return
List of FieldData
A table of FieldData.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for FieldData.