`ModalExcitationStoredData`

Stored excitation results.

Example

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

modalSource = pf.GetApplication().Models[1].Configurations[1].Excitations["ABSource1"]

    -- Store a copy of the Modal port excitation data.

storedData = modalSource:StoreData()

Inheritance

The ModalExcitationStoredData 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 source values. (Returns a DataSet object.)
GetDataSet (samplePoints number): Returns a data set containing the source values. (Returns a DataSet object.)
GetDataSet (startFrequency number, endFrequency number, samplePoints number): Returns a data set containing the source 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 source values.

Return

DataSet: The data set containing the source values.

GetDataSet (samplePoints number)

Returns a data set containing the source values.

Input Parameters

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

Return

DataSet: The data set containing the source values.

GetDataSet (startFrequency number, endFrequency number, samplePoints number)

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