RFmxLteMXComponentCarrier.GetComponentCarrierAtCenterFrequency Method
- Updated2024-07-17
- 1 minute(s) read
RFmxLteMXComponentCarrierGetComponentCarrierAtCenterFrequency Method
Gets the index of the component carrier having its center at the user-configured center frequency. RFmxLTE uses this method along with ComponentCarrierSpacingType method to calculate the value of the SetFrequency(String, Double).
Namespace: NationalInstruments.RFmx.LteMX
Assembly: NationalInstruments.RFmx.LteMX.Fx40 (in NationalInstruments.RFmx.LteMX.Fx40.dll) Version: 24.5.0.49283 (24.5.0.49283)
Syntax
public int GetComponentCarrierAtCenterFrequency( string selectorString, out int value )
Public Function GetComponentCarrierAtCenterFrequency ( selectorString As String, <OutAttribute> ByRef value As Integer ) As Integer
Parameters
- selectorString
- Type: SystemString
Specifies the subblock number.
Example: "subblock0".
You can use the BuildSubblockString(String, Int32) method to build the selector string. - value
- Type: SystemInt32
Upon return, contains the index of the component carrier having its center at the user-configured center frequency. RFmxLTE uses this method along with ComponentCarrierSpacingType method to calculate the value of the SetFrequency(String, Double).
Return Value
Type: Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.
Remarks
This method gets the value of ComponentCarrierAtCenterFrequency attribute. Valid values are -1, 0, 1 ... n - 1, inclusive, where n is the number of component carriers in the subblock. The default value is -1. If the value is -1, the component carrier frequency values are calculated such that the center of aggregated carriers (subblock) lies at the Center Frequency. This property is ignored if you set the CC Spacing Type property to User.