# FieldDataCollection

A collection of field data.

## Example

application = cf.Application.GetInstance()
project = application:NewProject()

-- Retrieve the project's 'FieldDataCollection'

fieldDataCollection = project.Definitions.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]

## Inheritance

The FieldDataCollection object is derived from the AbstractModifiableCollection object.

## Usage locations

The FieldDataCollection object can be accessed from the following locations:

## Property List

Count
The number of FieldData items in the collection. (Read only number)
Label
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.)
Create a far field data by importing from a known file format. (Returns a FarFieldData object.)
AddFarFieldDataUsingStructure (filename string, numberthetapoints Expression, numberphipoints Expression)
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 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 mode data. (Returns a SphericalModeDataFromFile object.)
Create a spherical mode data by importing the modes from a known file format. (Returns a SphericalModeDataFromFile object.)
Create a spherical modes data by specifying the individual complex weightings for each spherical mode. (Returns a SphericalModeDataManuallySpecified 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.)
Item (index number)
Returns the FieldData for the given index in the collection. (Returns a FieldData object.)
Item (label string)
Returns the FieldData for the given label in the collection. (Returns a FieldData object.)
Items ()
Returns a table of FieldData items. (Returns a UnsupportedType(List of FieldData) 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

Count
The number of FieldData items in the collection.
Type
number
Access
Label
The object label.
Type
string
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
properties(table)
A table of properties defining the new far field data.
Return
FarFieldData
The far field data.
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.
AddFarFieldDataUsingStructure (filename string, numberthetapoints Expression, numberphipoints Expression)
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(Expression)
The number of theta points used for the data.
numberphipoints(Expression)
The number of phi points used for the 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
properties(table)
A table of properties defining the new near field data.
Return
NearFieldDataFullImport
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 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 mode data.
Input Parameters
properties(table)
A table of properties defining the new spherical modes data.
Return
SphericalModeDataFromFile
The spherical modes data.
Create a spherical mode data by importing the modes from a known file format.
Input Parameters
filename(string)
Import file containing the spherical modes data.
Return
SphericalModeDataFromFile
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
SphericalModeDataManuallySpecified
The spherical modes data.
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.
Item (index number)
Returns the FieldData for the given index in the collection.
Input Parameters
index(number)
The index of the FieldData.
Return
FieldData
The item in the collection
Item (label string)
Returns the FieldData for the given label in the collection.
Input Parameters
label(string)
The label of the FieldData.
Return
FieldData
The item in the collection
Items ()
Returns a table of FieldData items.
Return
UnsupportedType(List of FieldData)
The list of items in the collection
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.