Write-only

About File Import

Description

Import data from a TouchStone file(*.sNp), CitiFile, or Text file (tab delimited or comma delimited).

 VB Syntax

plts.ImportFile fileName, analysisType, docObject, viewObject, portNum, portMap, diffPortMap, dutCfgDesc, freqStart, freqStop, freqStep

Notes:

For the following variables:  portMap, diffPortMap, dutCfgDesc -If portNum is equal to the port number of the original data, then the value of the original data will be used as default values. Otherwise, default values will be generated.

The following variables: freqStart, freqStop, freqStep - are used to import a subset frequency range of data from the original data.

Variable

(Type) - Description

plts

(object) - A PLTSApplication object

fileName

(String) Full path name and suffix of the file to be loaded.

analysisType

(Short) Analysis view that is displayed after file opened.  Provide either the number or enumeration type depending on your programming environment.

0 - TIME_DIFF  (Time domain differential)

1 - TIME_SNGL  (Time domain single-ended)

2 - FREQ_BAL  (Frequency domain balanced)

3 - FREQ_SNGL  (Frequency domain single-ended)

4 - EYE_DIFF  (Eye diagram differential)

5 - EYE_SNGL  (Eye diagram single-ended)

6 - RLCGD  (RLCG differential)

7 - RLCGC  (RLCG common)

8 - RLCGWE  (RLCG W element)

9 - RLCGSM  (RLCG self mutual)

docObject

[out] Returns a handle to the opened IPLTSDocument object.

viewObject

[out] Returns a handle to the opened analysis IPLTSView object.

portNum

(Short) Port number after import. Specify -1 to use the port number from the imported file.

portMap

(String) Port map after import.

Specify "" to use the default value.

diffPortMap

(String) Differential port map after import.

Specify "" to use the default value.

dutCfgDesc

(String) DUT configuration description after import.

Specify "" to use the default value.

freqStart

(Double) Start frequency value, in MHz, after import.

Specify  -1 to use the start frequency of the original data.

freqStop

(Double) Stop frequency value, in MHz, after import.

Specify  -1 to use the stop frequency of the original data.

freqStep

(Double) Step frequency value, in MHz, after import.

Specify  -1 to use the step frequency of the original data.

Return Type

None

Default

None

Examples

string filePath = "C://Program Files//Keysight//PLTS_4.0//Data//";

//Import a TouchStone file with the default DUT configurations and frequency range

int stat = pltsapp.ImportFile(filePath + "snv.s4p", (short)pltsAnalysisType.FREQ_SNGL, ref objDoc, ref objView,-1, null, null, null, -1, -1, -1);

C++ Syntax

HRESULT ImportFile(BSTR szFileName, SHORT analysisType, IDispatch** ppDoc, IDispatch** ppView, SHORT portNmbr, BSTR portMap, BSTR diffPortMap, BSTR dutCfgDesc, DOUBLE freqStart, DOUBLE freqStop, DOUBLE freqStep);

Interface

IPLTSApplication