`WireCurrentsTrace`

A wire currents 2D trace.

Example

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

    -- Add a cartesian graph to plot the traces on

cartGraph = app.CartesianGraphs:Add()

    -- Add the wire currents to the Traces collection of the Cartesian graph

wireCurrentTrace = cartGraph.Traces:Add(app.Models[1].Configurations[1].WireCurrents[1])

    -- Set the independent axis to "Segments"
    
wireCurrentTrace.IndependentAxis = "Segments"

    -- Change the value of the fixed axis (to the highest frequency)

freqValueOptions = wireCurrentTrace:GetFixedAxisAvailableValues("Frequency")
unit = wireCurrentTrace:GetAxisUnit("Frequency")
wireCurrentTrace:SetFixedAxisValue("Frequency", tonumber(freqValueOptions[#freqValueOptions]), unit)

    -- Set the fixed Segment axis to "Line1.Wire1"
    
wireCurrentTrace:SetFixedAxisValue("Segments", "Line1.Wire1")

    -- Ensure the entire graph is visible
    
cartGraph:ZoomToExtents()

Inheritance

The WireCurrentsTrace object is derived from the ResultTrace object.

Property List

Axes: The trace axes properties. (Read only TraceAxes)
AxisNames: The names of all the axes on the ResultPlot. (Read only List of string)
DataSource: The source of the trace. (Read/Write ResultData)
FixedAxes: The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well as the contents of the ResultData object. The value for a specific fixed axis can be queried and set with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string)
IndependentAxesAvailable: The list of available independent axes. (Read only List of string)
IndependentAxis: The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc. (Read/Write string)
Label: The object label. (Read/Write string)
Legend: The trace legend properties. (Read only TraceLegendFormat)
Line: The trace line format properties. (Read only TraceLineFormat)
Markers: The trace marker format properties. (Read only TraceMarkersFormat)
Math: The wire currents and charges trace math expression properties. (Read only TraceMathExpression)
Quantity: The wire currents and charges trace quantity properties. (Read only WireCurrentsQuantity)
Sampling: The continuous trace sampling settings. These settings only apply to traces when the independent axis is continuously sampled. (Read only TraceSamplingFormat)
Type: The object type string. (Read only string)
Values: The values that are plotted on the graph for this trace. The first column represents the independent axis and the second column represents the scalar quantity being displayed on the graph. Each row represents a sampled coordinate pair. (Read only Matrix)
Visible: Specifies whether the trace must be shown or hidden. (Read/Write boolean)

Method List

Delete (): Delete the trace.
Duplicate (): Duplicate the trace. (Returns a ResultTrace object.)
GetAxisUnit (axis string): Returns the SI unit of the specified axis. (Returns a string object.)
GetFixedAxisAvailableValues (axis string): Returns the list of available values for the specified axis. (Returns a List of string object.)
GetFixedAxisValue (axis string): Returns the current value for the specified fixed axis. (Returns a string 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.)
Lower (): Lower the trace.
Raise (): Raise the trace.
SetFixedAxisValue (axis string, numvalue number, unit string): Set the fixed axis to the specified value.
SetFixedAxisValue (axis string, strvalue string): Set the fixed axis to the specified value.
SetProperties (properties table): 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.
Store (): Store a copy of the trace. (Returns a ResultTrace object.)

Property Details

Axes

The trace axes properties.

Type: TraceAxes
Access: Read only

AxisNames

The names of all the axes on the ResultPlot.

Access: Read only

DataSource

The source of the trace.

Type: ResultData
Access: Read/Write

FixedAxes

The list of fixed axes for this plot. The fixed axes depend on the chosen IndependentAxis as well as the contents of the ResultData object. The value for a specific fixed axis can be queried and set with the GetFixedAxisValue() and SetFixedAxisValue() methods.

Access: Read only

IndependentAxesAvailable

The list of available independent axes.

Access: Read only

IndependentAxis

The independent axis of the plot to be displayed, e.g., Frequency, X, Y, Z, etc.

Type: string
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

Legend

The trace legend properties.

Type: TraceLegendFormat
Access: Read only

Line

The trace line format properties.

Type: TraceLineFormat
Access: Read only

Markers

The trace marker format properties.

Type: TraceMarkersFormat
Access: Read only

Math

The wire currents and charges trace math expression properties.

Type: TraceMathExpression
Access: Read only

Quantity

The wire currents and charges trace quantity properties.

Type: WireCurrentsQuantity
Access: Read only

Sampling

The continuous trace sampling settings. These settings only apply to traces when the independent axis is continuously sampled.

Type: TraceSamplingFormat
Access: Read only

Type

The object type string.

Type: string
Access: Read only

Values

The values that are plotted on the graph for this trace. The first column represents the independent axis and the second column represents the scalar quantity being displayed on the graph. Each row represents a sampled coordinate pair.

Type: Matrix
Access: Read only

Visible

Specifies whether the trace must be shown or hidden.

Type: boolean
Access: Read/Write

Method Details

Delete ()

Delete the trace.

Duplicate ()

Duplicate the trace.

Return

ResultTrace: The duplicated trace.

GetAxisUnit (axis string)

Returns the SI unit of the specified axis.

Input Parameters

axis(string): The axis.

Return

string: The SI unit string.

GetFixedAxisAvailableValues (axis string)

Returns the list of available values for the specified axis.

Input Parameters

axis(string): The fixed axis.

Return

List of string: The axis values.

GetFixedAxisValue (axis string)

Returns the current value for the specified fixed axis.

Input Parameters

axis(string): The fixed axis.

Return

string: The axis value.

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 properties table.

Lower ()

Lower the trace.

Raise ()

Raise the trace.

SetFixedAxisValue (axis string, numvalue number, unit string)

Set the fixed axis to the specified value.

Input Parameters

axis(string): The fixed axis.
numvalue(number): The axis value.
unit(string): The given value's unit. Provide an empty string if it has no unit.

SetFixedAxisValue (axis string, strvalue string)

Set the fixed axis to the specified value.

Input Parameters

axis(string): The fixed axis.
strvalue(string): The axis value.

SetProperties (properties table)

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(table): A table of properties defining the new state of the object.

Store ()

Store a copy of the trace.

Return

ResultTrace: A copy of the trace.