Frequency
A solution frequency range.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Set a frequency range between 100MHz to 500MHz with 9 discrete frequencies frequencyRange = project.Contents.SolutionConfigurations.GlobalFrequency properties = frequencyRange:GetProperties() properties.RangeType = cf.Enums.FrequencyRangeTypeEnum.LinearSpacedDiscrete properties.Start = "100e6" properties.End = "500e6" properties.NumberOfDiscreteValues = "9" frequencyRange:SetProperties(properties)
Inheritance
Usage locations
The Frequency object can be accessed from the following locations:
- Properties
- SolutionConfigurationCollection collection has property GlobalFrequency.
- SolutionConfiguration object has property Frequency.
- CharacteristicModesConfiguration object has property Frequency.
- SParameterConfiguration object has property Frequency.
- StandardConfiguration object has property Frequency.
Property List
- Advanced
- Advanced frequency settings. (Read/Write FrequencyAdvancedSettings)
- DiscreteFrequencies
- The collection of discrete frequencies. Only valid when Type is DiscreteList. (Read/Write ParametricExpressionList)
- End
- The last frequency value (Hz). (Read/Write ParametricExpression)
- Export
- Continuous frequency export settings. (Read/Write FrequencyExportSettings)
- Label
- The object label. (Read/Write string)
- NumberOfDiscreteValues
- The number of discrete frequency values. Only valid when Type is LogarithmicSpacedDiscrete or LinearSpacedDiscrete. (Read/Write ParametricExpression)
- RangeType
- The frequency range type. (Read/Write FrequencyRangeTypeEnum)
- Start
- The first frequency value (Hz). (Read/Write ParametricExpression)
- Type
- The object type string. (Read only string)
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- 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 Object)
- 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.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- Advanced
- Advanced frequency settings.
- Type
- FrequencyAdvancedSettings
- Access
- Read/Write
- DiscreteFrequencies
- The collection of discrete frequencies. Only valid when Type is DiscreteList.
- Type
- ParametricExpressionList
- Access
- Read/Write
- End
- The last frequency value (Hz).
- Type
- ParametricExpression
- Access
- Read/Write
- Export
- Continuous frequency export settings.
- Type
- FrequencyExportSettings
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- NumberOfDiscreteValues
- The number of discrete frequency values. Only valid when Type is LogarithmicSpacedDiscrete or LinearSpacedDiscrete.
- Type
- ParametricExpression
- Access
- Read/Write
- RangeType
- The frequency range type.
- Type
- FrequencyRangeTypeEnum
- Access
- Read/Write
- Start
- The first frequency value (Hz).
- Type
- ParametricExpression
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- 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 table defining the properties.
- SetProperties (properties Object)
- 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(Object)
- A table of properties defining the new state of the object.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.