Write-only
About Exporting Data

ExportFreqDomainTextFile Method


Description

Export data by specifying parameters with this method.

You can also specify parameters using separate commands. Learn how.

 VB Syntax

doc.ExportFreqDomainTextFile (fileName, delimiterType, dataFormat, portNmbr, portMap, diffPortMap, dutCfgDesc, dataToExport, paramList, exportGated, ExportInOneFile, freqUnit, dataRange, startFreqMHz, stopFreqMHz, stepFreqMHz

Variable

(Type) - Description

doc

(object) - A PLTSDoc object

fileName

(String) Full path, file name, and suffix of exported file.

delimiterType

(Integer) Choose the type of text file to export.

0 - Tab

1 - Comma

dataFormat

(Integer)(Enum as pltsFreqDomainTextFileDataFormat) Data format. Choose from:

0 - RI  (Real / Imaginary)

1 - LogMag  

2 - Linear  

3 - Phase  

portNmbr

(Integer) - Number of DUT ports for which data will be exported. Learn more.

 -1 specifies the port number of the original data.

portMap

(String) Mapping of ports to export. Learn more

" " specifies the original port mapping.

diffPortMap

(String) Mapping of ports to export. Learn more

" " specifies the original port mapping.

dutCfgDesc

(String) Description of the DUT configuration after export. Learn more.

Use " " to use the current DUT configuration.

dataToExport

(Enum as pltsTextFileDataToExport) Parameter data to export. Choose from:

0 - SE (all single-ended parameters)

1 - Balanced (all balanced parameters)

2 - All (all single-ended and balanced parameters)

3 - Customized (parameters selected using the following paramList argument.

paramList

(String) List of parameter to export separated by commas. Use " " when the previous argument is NOT Customized. Learn more.

exportGated

(Boolean) Export gated data. Choose from:

0- False  Ungated, calibrated data is exported.

1 - True  Gated data is exported.

Learn more.

ExportInOneFile

(Boolean) Export all data in one file or to separate files. Choose from:

0- False  All selected parameters are saved to separate files. Each file is saved to the specified folder with the filename you entered and a parameter label appended to the name. For example, if you entered device4 as the file name, the S11 parameter file is named: device4_S11.txt.

1 - True  All selected parameters are saved to one file.

freqUnit

(Enum) Units to use when exporting frequency domain data. Choose from:

0 - MHz

1 - GHz

dataRange

(Integer)t The data range to export. Choose from:

0 - RangeAll - Export the entire data range in PLTS memory.

1 - Subset  The data range is specified with the following arguments: (start freq, stop freq and step freq)

startFreqMHz

(Double)  Start Frequency to export when Subset of data is selected.

stopFreqMHz

(Double)  Stop Frequency to export when Subset of data is selected.

stepFreqMHz

(Double)  Step Frequency (number of points) to export when Subset of data is selected.

Return Type

None

Default

None

Examples

doc.ExportFreqDomainTextFile "C:/PLTS/MyDut.dut", 0,1,-1," "," ","MyExportedData",3,"S11,S22",0,1,1,1,1.5,2.5,.1

C++ Syntax

HRESULT ExportFreqDomainTextFile(BSTR fileName, SHORT delimiterType, SHORT dataFormat, SHORT portNmbr, BSTR portMap, BSTR diffPortMap, BSTR dutCfgDesc, SHORT dataToExport, BSTR paramList, VARIANT_BOOL exportGated, VARIANT_BOOL exportInOneFile, SHORT freqUnit, SHORT dataRange, DOUBLE startFreqMHz, DOUBLE stopFreqMHz, DOUBLE stepFreqMHz);

Interface

IPLTSDocument