`CharacteristicModeStoredData`

Stored characteristic mode results.

Example

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

    -- Retrieve the 'CharacteristicModeData' from the characteristic mode configuration

charMode = app.Models[1].Configurations["CharacteristicModeConfiguration1"].CharacteristicModes[1]

    -- Store a copy of the CharacteristicModes data.
    
storedData = charMode:GetDataSet():StoreData(pf.Enums.StoredDataTypeEnum.CharacteristicMode)

Inheritance

The CharacteristicModeStoredData object is derived from the ResultData object.

Property List

ContinuousFrequencyAxis: Continuous frequency axis exists. (Read only boolean)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Delete (): Delete the stored data.
GetDataSet (): Returns a data set containing the characteristic mode values. (Returns a DataSet object.)
GetDataSet (samplePoints number): Returns a data set containing the characteristic mode values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number): Returns a data set containing the characteristic mode values. (Returns a DataSet object.)

Property Details

ContinuousFrequencyAxis

Continuous frequency axis exists.

Type: boolean
Access: Read only

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.

GetDataSet ()

Returns a data set containing the characteristic mode values.

Return

DataSet: The data set containing the characteristic mode values.

GetDataSet (samplePoints number)

Returns a data set containing the characteristic mode values.

Input Parameters

samplePoints(number): The number of sample points used to sample the continuous frequency axis.

Return

DataSet: The data set containing the characteristic mode values.

GetDataSet (startFrequency number, endFrequency number, samplePoints number)

Returns a data set containing the characteristic mode 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 characteristic mode values.