Frequency

A solution frequency range.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Set a frequency range between 100MHz to 500MHz with 9 discrete frequencies

frequencyRange = project.SolutionConfigurations["StandardConfiguration1"].Frequency
properties = frequencyRange:GetProperties()
properties.RangeType = cf.Enums.FrequencyRangeTypeEnum.LinearSpacedDiscrete
properties.Start = "100e6"
properties.End = "500e6"
properties.NumberOfDiscreteValues = "9"
frequencyRange:SetProperties(properties)

Usage locations (object properties)

The following objects have properties using the Frequency object:

Property List

Advanced
Advanced frequency settings. (Read only FrequencyAdvancedSettings)
DiscreteFrequencies
The collection of discrete frequencies. Only valid when Type is DiscreteList. (Read/Write List of Expression)
End
The last frequency value (Hz). (Read/Write Expression)
Export
Continuous frequency export settings. (Read only FrequencyExportSettings)
NumberOfDiscreteValues
The number of discrete frequency values. Only valid when Type is LogarithmicSpacedDiscrete or LinearSpacedDiscrete. (Read/Write Expression)
RangeType
The frequency range type. (Read/Write FrequencyRangeTypeEnum)
Start
The first frequency value (Hz). (Read/Write Expression)
Type
The object type string. (Read only string)

Method List

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.)
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.

Property Details

Advanced
Advanced frequency settings.
Type
FrequencyAdvancedSettings
Access
Read only
DiscreteFrequencies
The collection of discrete frequencies. Only valid when Type is DiscreteList.
Access
Read/Write
End
The last frequency value (Hz).
Type
Expression
Access
Read/Write
Export
Continuous frequency export settings.
Type
FrequencyExportSettings
Access
Read only
NumberOfDiscreteValues
The number of discrete frequency values. Only valid when Type is LogarithmicSpacedDiscrete or LinearSpacedDiscrete.
Type
Expression
Access
Read/Write
RangeType
The frequency range type.
Type
FrequencyRangeTypeEnum
Access
Read/Write
Start
The first frequency value (Hz).
Type
Expression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

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