`DataSetAxisCollection`

A data set contains a collection of axes. A handle can be obtained on an individual axis, or new axes can be added to the collection by using the DataSetAxisCollection.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])

    -- Retrieve the far field data set
    
farFieldDataSet = app.Models[1].Configurations[1].FarFields["FarFields"]:GetDataSet(51)

    -- Print a list of the far field axes
    
printlist( farFieldDataSet.Axes:Items() )

    -- Access the axes

frequencyAxis = farFieldDataSet.Axes[1] -- Index method
frequencyAxis = farFieldDataSet.Axes["Frequency"] -- Name method
numberAxes = #farFieldDataSet.Axes

Usage locations

The DataSetAxisCollection object can be accessed from the following locations:

Collection lists
- DataSet object has collection Axes.

Property List

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

Method List

Add (type DataSetAxisEnum): Adds an empty axis to the data set. Only the type is known, the other properties (i.e. the unit and values) must still be provided. (Returns a DataSetAxis object.)
Add (type DataSetAxisEnum, start number, end number, count number): Adds a standard axis to the data set with a range of values. (Returns a DataSetAxis object.)
Add (type DataSetAxisEnum, values List of Variant): Adds a standard axis to the data set with a given set of values. (Returns a DataSetAxis object.)
Add (name string, unit Unit): Adds an empty axis to the data set. The values must still be provided. (Returns a DataSetAxis object.)
Add (name string, unit Unit, value Variant): Adds a new axis to the data set with a single value. (Returns a DataSetAxis object.)
Add (name string, unit Unit, start number, end number, count number): Adds a new axis to the data set with a range of values. (Returns a DataSetAxis object.)
Add (name string, unit Unit, values List of Variant): Adds a new axis to the data set with a given set of values. (Returns a DataSetAxis object.)
Add (axis DataSetAxis): Adds a copy of the given axis to the data set. (Returns a DataSetAxis object.)
Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number): Returns the DataSetAxis at the given index. (Returns a DataSetAxis object.)
Item (label string): Returns the DataSetAxis with the given label. (Returns a DataSetAxis object.)
Items (): Returns a table of DataSetAxis. (Returns a List of DataSetAxis 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 DataSetAxis at the given index in the collection. (Read DataSetAxis)
[string]: Returns the DataSetAxis with the given name in the collection. (Read DataSetAxis)

Property Details

Count

The number of DataSetAxis items in the collection.

Type: number
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Method Details

Add (type DataSetAxisEnum)

Adds an empty axis to the data set. Only the type is known, the other properties (i.e. the unit and values) must still be provided.

Input Parameters

type(DataSetAxisEnum): The built-in axis type to add.

Return

DataSetAxis: The new axis.

Add (type DataSetAxisEnum, start number, end number, count number)

Adds a standard axis to the data set with a range of values.

Input Parameters

type(DataSetAxisEnum): The built-in axis type to add.
start(number): The first value of the axis.
end(number): The last value of the axis.
count(number): The number of points on the axis.

Return

DataSetAxis: An axis defined over a range of values.

Add (type DataSetAxisEnum, values List of Variant)

Adds a standard axis to the data set with a given set of values.

Input Parameters

type(DataSetAxisEnum): The built-in axis type to add.
values(List of Variant): The values of the axis in a table.

Return

DataSetAxis: A new axis with no unit.

Add (name string, unit Unit)

Adds an empty axis to the data set. The values must still be provided.

Input Parameters

name(string): The name of the axis.
unit(Unit): The unit of the axis.

Return

DataSetAxis: A new axis containing no values.

Add (name string, unit Unit, value Variant)

Adds a new axis to the data set with a single value.

Input Parameters

name(string): The name of the axis.
unit(Unit): The unit of the axis.
value(Variant): The value.

Return

DataSetAxis: A new axis containing a single value.

Add (name string, unit Unit, start number, end number, count number)

Adds a new axis to the data set with a range of values.

Input Parameters

name(string): The name of the axis.
unit(Unit): The unit of the axis.
start(number): The first value of the axis.
end(number): The last value of the axis.
count(number): The number of points on the axis.

Return

DataSetAxis: A new axis defined over a range of values.

Add (name string, unit Unit, values List of Variant)

Adds a new axis to the data set with a given set of values.

Input Parameters

name(string): The name of the axis.
unit(Unit): The unit of the axis.
values(List of Variant): The values of the axis in a table.

Return

DataSetAxis: The new axis.

Add (axis DataSetAxis)

Adds a copy of the given axis to the data set.

Input Parameters

axis(DataSetAxis): The axis to add.

Return

DataSetAxis: The new axis.

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the DataSetAxis.

Return

boolean: The success of the check.

Item (index number)

Returns the DataSetAxis at the given index.

Input Parameters

index(number): The index of the DataSetAxis.

Return

DataSetAxis: The DataSetAxis at the given index.

Item (label string)

Returns the DataSetAxis with the given label.

Input Parameters

label(string): The label of the DataSetAxis.

Return

DataSetAxis: The DataSetAxis with the given label.

Items ()

Returns a table of DataSetAxis.

Return

List of DataSetAxis: A table of DataSetAxis.

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 DataSetAxis.