RFmxInstrMX.GetSParameterExternalAttenuationType Method
- Updated2024-07-17
- 2 minute(s) read
RFmx
Returns the type of S-parameter to apply to measurements on the specified port for a Calplane. You can use the selectorString input to specify the name of the Calplane and port to configure for s-parameter.
Supported devices: PXIe-5830/5831/5832/5840
Namespace: NationalInstruments.RFmx.InstrMX
Assembly: NationalInstruments.RFmx.InstrMX.Fx40 (in NationalInstruments.RFmx.InstrMX.Fx40.dll) Version: 24.5.0.49285 (24.5.0.49285)
Syntax
public int GetSParameterExternalAttenuationType( string selectorString, out RFmxInstrMXSParameterType sParameterType )
Public Function GetSParameterExternalAttenuationType ( selectorString As String, <OutAttribute> ByRef sParameterType As RFmxInstrMXSParameterType ) As Integer
Parameters
- selectorString String
-
Specifies the calibration plane name in which either S-parameter or external attenuation table is stored. This input accepts the calibration plane name with the "calplane::" prefix. If you do not specify the calibration plane name, the default calibration plane instance is used. The default value is "" (empty string).
On a MIMO session if you do not specify the port name, this configuration is applied to all MIMO ports in the session for the default calibration plane instance. To configure S-parameter external attenuation table for a specific MIMO port, use the port specifier with or without the calplane name. Example: "calplane::plane1/port::myrfsa1/0".
Note
For PXIe-5830/5831/5832 devices, port names should also be specified along with Calplane names. Hence, the valid selector is "calplane::<calplaneName>/port::<portName>". Hence, the valid selector string is "calplane::(calplaneName)/port::(deviceName)/(channelNumber)/(portName)". For a MIMO port, the valid selector string is "calplane::(calplaneName)/port::(deviceName)/(channelNumber)/(portName)". If you specify "port::all", all MIMO ports are considered configured. Use RFmxInstrMX.GetAvailablePorts method to get the valid port names. Example:
""
"calplane::plane0"
"calplane::plane0/port::if0"
"port::if0"
"calplane::plane0/port::myrfsa1/0"
"calplane::plane0/port::myrfsa1/0/if0"
- sParameterType RFmxInstrMXSParameterType
- Returns the type of S-parameter which applies to measurements on the specified port for a Calplane.
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes an error or warning condition.