TRCoefficientStoredData

Stored transmission reflection coefficient results.

Example

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

    -- Retrieve the 'TRCoefficientData' called 'TRCoefficient1'

TRCoefficientData = app.Models[1].Configurations[1].TRCoefficients["TRCoefficients1"]

    -- Store a copy of the network data.
    
storedData = TRCoefficientData:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.TRCoefficient)

Inheritance

The TRCoefficientStoredData object is derived from the ResultData object.

Property List

Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

Delete ()
Delete the stored data.
ExportData (filename string)
Export the transmission reflection coefficient data to the specified *.tr file.
ExportData (filename string, samples number)
Export the transmission reflection coefficient data to the specified *.tr file.
GetDataSet ()
Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet object.)
GetDataSet (samplePoints number)
Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number)
Returns a data set containing the transmission reflection coefficient values. (Returns a DataSet object.)

Property Details

Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Delete ()
Delete the stored data.
ExportData (filename string)
Export the transmission reflection coefficient data to the specified *.tr file.
Input Parameters
filename(string)
The name of the exported data file without its extension.
ExportData (filename string, samples number)
Export the transmission reflection coefficient data to the specified *.tr file.
Input Parameters
filename(string)
The name of the exported data file without its extension.
samples(number)
The number of samples for continuous data. This value will be ignored if the data is discrete.
GetDataSet ()
Returns a data set containing the transmission reflection coefficient values.
Return
DataSet
The data set containing the transmission reflection coefficient values.
GetDataSet (samplePoints number)
Returns a data set containing the transmission reflection coefficient values.
Input Parameters
samplePoints(number)
The number of sample points used to sample the continuous frequency axis.
Return
DataSet
The data set containing the transmission reflection coefficient values.
GetDataSet (startFrequency number, endFrequency number, samplePoints number)
Returns a data set containing the transmission reflection coefficient values.
Input Parameters
startFrequency(number)
The start frequency used to sample the continuous frequency axis.
endFrequency(number)
The end frequency used to sample the continuous frequency axis.
samplePoints(number)
The number of sample points used to sample the continuous frequency axis.
Return
DataSet
The data set containing the transmission reflection coefficient values.