FrequencyExportSettings

Properties that control how continuous frequency is sampled for exporting. These properties are only valid when Frequency Type is Continuous.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Initialise the frequency to a continuous band

frequency = project.Contents.SolutionConfigurations.GlobalFrequency
properties = frequency:GetProperties()
properties.Start = 100e6
properties.End = 200e6
properties.RangeType = cf.Enums.FrequencyRangeTypeEnum.Continuous
frequency:SetProperties(properties)

    -- Set the number of samples for export
    -- As the properties need to be modified in one step,
    -- a properties table is used

properties = frequency:GetProperties()
properties.Export.NumberOfSamplesEnabled = true
properties.Export.NumberOfSamples = 10
frequency:SetProperties(properties)

Inheritance

The FrequencyExportSettings object is derived from the CompositeValue object.

Usage locations

The FrequencyExportSettings object can be accessed from the following locations:

Property List

NumberOfSamples
Number of frequency samples for exported continuous data. Only valid when NumberOfSamplesEnabled is true. (Read/Write ParametricExpression)
NumberOfSamplesEnabled
Specify the number of samples to use when exporting data with continuous frequency. (Read/Write boolean)
Stepping
Control how exported continuous frequency samples are spaced. (Read/Write FrequencyExportSamplingTypeEnum)

Property Details

NumberOfSamples
Number of frequency samples for exported continuous data. Only valid when NumberOfSamplesEnabled is true.
Type
ParametricExpression
Access
Read/Write
NumberOfSamplesEnabled
Specify the number of samples to use when exporting data with continuous frequency.
Type
boolean
Access
Read/Write
Stepping
Control how exported continuous frequency samples are spaced.
Type
FrequencyExportSamplingTypeEnum
Access
Read/Write