RFmxVnaMXSParamsConfiguration Class
- Updated2024-07-17
- 5 minute(s) read
RFmx
Provides methods to configure the SParams measurement.
Inheritance Hierarchy
Namespace: NationalInstruments.RFmx.VnaMX
Assembly: NationalInstruments.RFmx.VnaMX.Fx40 (in NationalInstruments.RFmx.VnaMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)
Syntax
public sealed class RFmxVnaMXSParamsConfiguration : RFmxVnaMXSubObject
Public NotInheritable Class RFmxVnaMXSParamsConfiguration Inherits RFmxVnaMXSubObject
The RFmxVnaMXSParamsConfiguration type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | ConfigureSParameter | Configures the S-Parameter to be measured in format S<receiver port number><source port number> Use "sparam<n>" as the selector string to configure this method. |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object) |
| ExportToSnPFile |
Exports the measured S-parameters to (SnP File Path). Configure (SnP Export) methods: Data Format to save the S-parameters in desired format User Comment to add additional information to the file header Ports to save S-parameters for a subset of the available VNA ports Note In addition to the above methods, the available S-parameters to export depend on the configured measurement and calibration state of the instrument. |
| GetFormat |
Gets the format of S-Parameter measurement. Use 'sparam(n)' as the selector string to configure or read this attribute.
Use RFmxVNA SParams Fetch Real Data to fetch the S-Parameters for which you configured this attribute to Magnitude (0), Phase (1) or SWR (3). Use RFmxVNA SParams Fetch Complex Data to fetch the S-Parameters for which you configured this attribute to Complex (2), Smith Impedance (4) or Smith Admittance (5). |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object) |
| GetMagnitudeUnits | Gets the magnitude units for all S-Parameters for which (a href="javascript:launchmergedhelp('rfmxvna.chm', 'rfmxvnacvi.chm', 'RFMXVNA_ATTR_SPARAMS_FORMAT.html')")RFMXVNA_ATTR_SPARAMS_FORMAT(/a) method is set to (format type="bold")Magnitude(/format). |
| GetMeasurementEnabled | Gets whether to enable the Sparams measurement. |
| GetNumberOfSParameters | Gets the number of S-Parameters to measure. |
| GetPhaseTraceType | Gets the phase type for all S-Parameters for which (a href="javascript:launchmergedhelp('rfmxvna.chm', 'rfmxvnacvi.chm', 'RFMXVNA_ATTR_SPARAMS_FORMAT.html')")RFMXVNA_ATTR_SPARAMS_FORMAT(/a) method is set to (format type="bold")Phase(/format). |
| GetReceiverPort | Gets the receiver port name of the S-Parameter. S-Parameter is denoted by "S_(receiver port name)_(receiver port name)".For example, to measure S_port2_port1, set this method to "port2". |
| GetSnPDataFormat | Gets the SParams Data Format of the S-parameter measurement to be saved. |
| GetSnPPorts | Gets the Ports for which the S-parameter measurement is saved to file. |
| GetSnPUserComment | Gets user-specific additional information passed as SParams User Comment to write to SnP file. |
| GetSourcePort | Gets the source port name of the S-Parameter. S-Parameter is denoted by "S_(receiver port name)_(receiver port name)".For example, to measure S_port2_port1, set this method to "port1". |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| SetFormat |
Sets the format of S-Parameter measurement. Use 'sparam(n)' as the selector string to configure or read this attribute.
Use RFmxVNA SParams Fetch Real Data to fetch the S-Parameters for which you configured this attribute to Magnitude (0), Phase (1) or SWR (3). Use RFmxVNA SParams Fetch Complex Data to fetch the S-Parameters for which you configured this attribute to Complex (2), Smith Impedance (4) or Smith Admittance (5). |
| SetMagnitudeUnits | Sets the magnitude units for all S-Parameters for which (a href="javascript:launchmergedhelp('rfmxvna.chm', 'rfmxvnacvi.chm', 'RFMXVNA_ATTR_SPARAMS_FORMAT.html')")RFMXVNA_ATTR_SPARAMS_FORMAT(/a) method is set to (format type="bold")Magnitude(/format). |
| SetMeasurementEnabled | Sets whether to enable the Sparams measurement. |
| SetNumberOfSParameters | Sets the number of S-Parameters to measure. |
| SetPhaseTraceType | Sets the phase type for all S-Parameters for which (a href="javascript:launchmergedhelp('rfmxvna.chm', 'rfmxvnacvi.chm', 'RFMXVNA_ATTR_SPARAMS_FORMAT.html')")RFMXVNA_ATTR_SPARAMS_FORMAT(/a) method is set to (format type="bold")Phase(/format). |
| SetReceiverPort | Sets the receiver port name of the S-Parameter. S-Parameter is denoted by "S_(receiver port name)_(receiver port name)".For example, to measure S_port2_port1, set this method to "port2". |
| SetSnPDataFormat | Sets the SParams Data Format of the S-parameter measurement to be saved. |
| SetSnPPorts | Sets the Ports for which the S-parameter measurement is saved to file. |
| SetSnPUserComment | Sets user-specific additional information passed as SParams User Comment to write to SnP file. |
| SetSourcePort | Sets the source port name of the S-Parameter. S-Parameter is denoted by "S_(receiver port name)_(receiver port name)".For example, to measure S_port2_port1, set this method to "port1". |
| ToString | Returns a string that represents the current object. (Inherited from Object) |