source: 1dwg/trunk/IgorPro/documentation.html @ 7

Last change on this file since 7 was 7, checked in by prjemian, 13 years ago

use trunk,tags,branches

File size: 2.0 KB
Line 
1<HTML>
2  <HEAD>
3  </HEAD>
4  <BODY>
5    <PRE>
6FUNCTION CS_XmlReader(fileName)
7        //
8        // open a canSAS 1-D reduced SAS XML data file
9        //      returns:
10        //              0 : successful
11        //              -1: XML file not found
12        //              -2: root element is not <SASroot>
13        //              -3: <SASroot> version  is not 1.0
14        //              -4: no <SASentry> elements
15        //
16        STRING fileName
17        STRING origFolder
18        STRING workingFolder = "root:Packages:CS_XMLreader"
19        VARIABLE returnCode
20FUNCTION CS_1i_parseXml(fileID)
21FUNCTION CS_1i_collectMetadata(fileID, sasEntryPath)
22FUNCTION CS_fileExists(fileName)
23FUNCTION CS_appendMetaData(key, xpath, value)
24FUNCTION CS_findElementIndex(matchStr)
25FUNCTION CS_registerNameSpaces()
26FUNCTION/S CS_GetNameSpaceByKey(key)
27FUNCTION/S CS_GetKeyByNameSpace(ns)
28FUNCTION/S CS_XPath_NS(simpleStr)
29        // this function adds namespace info as necessary to simpleStr (an XPath)
30FUNCTION/S CS_buildXpathStr(prefix, value)
31        // this function can be used only with very simple XPath constructions
32FUNCTION/S CS_XmlStrFmXpath(fileID, prefix, value)
33FUNCTION CS_simpleXmlWaveFmXpath(fileID, prefix, value)
34FUNCTION CS_simpleXmlListXpath(fileID, prefix, value)
35Function/T   TrimWS(str)
36Function/T   TrimWSL(str)
37Function/T   TrimWSR(str)
38FUNCTION CS_updateWaveNote(wavName, key, value)
39FUNCTION CS_1i_extractIdataColumn2Wave(fileID, basePath, colName, wavName)
40        // this function pulls one column of data from each <Idata> element
41        // easier to write this as a function than debug it all the times it is needed
42        //
43        // avoid the use os the semicolon in anything that might make it into
44        //      the IgorPro wavenote since the semicolon is a list delimiter.
45        // The import macro defends against this by converting all semicolons
46        //      into the string " :semicolon: "
47FUNCTION CS_1i_extractSasData(fileID, SASdataPath, SASdata_folder)
48        //  (1i in the function name signifies this is a function that supports INPUT from version 1.0 XML files)
49FUNCTION prj_grabMyXmlData()
50FUNCTION prjTest_cansas1d()
51    </PRE>
52  </BODY>
53</HTML>
54
Note: See TracBrowser for help on using the repository browser.