DataSetAxis

Every DataSet contains axes and quantities. The DataSetAxis describes the definition of an axis.

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 information about the "Phi" axis
    
phiAxis = farFieldDataSet.Axes["Phi"]
phiAxisName = phiAxis.Name
phiAxisUnit = phiAxis.Unit
phiAxisDescription = phiAxis.Description
phiAxisValues = phiAxis.Values -- The actual phi values in degrees
numberPhiAxisValues = #phiAxis
firstPhiValue = phiAxis[1]
lastPhiValue = phiAxis[#phiAxis]

Usage locations

The DataSetAxis object can be accessed from the following locations:

Property List

Count
The number of values on the axis. (Read only number)
Description
A text description of the axis. (Read only string)
Name
The name of the axis. (Read/Write string)
Type
The object type string. (Read only string)
Unit
The unit for the axis. (Read/Write Unit)
Values
The values of the axis. (Read/Write List of Variant)

Method List

Delete ()
Deletes the axis from the dataset.
SetValueAt (index number, value Variant)
Set the value on the axis at the given index.
ValueAt (index number)
Returns the value on the axis at the given index. (Returns a Variant object.)

Index List

[number]
The value at the given index. (Read Variant)
[number]
The value at the given index. (Write Variant)

Property Details

Count
The number of values on the axis.
Type
number
Access
Read only
Description
A text description of the axis.
Type
string
Access
Read only
Name
The name of the axis.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Unit
The unit for the axis.
Type
Unit
Access
Read/Write
Values
The values of the axis.
Access
Read/Write

Method Details

Delete ()
Deletes the axis from the dataset.
SetValueAt (index number, value Variant)
Set the value on the axis at the given index.
Input Parameters
index(number)
The index of the value to access.
value(Variant)
The value to assign to the given index.
ValueAt (index number)
Returns the value on the axis at the given index.
Input Parameters
index(number)
The index of the value to access.
Return
Variant
The value at the given index.