= Rappture Matlab / Octave API =

== Summary: ==

'''Library''' Class [[BR]]

  These functions provide an interface to the Rappture I/O library.

  __'''Constructor'''__

  [''libHandle'',''err''] = '''rpLib(''' ''fileName'' ''')''' [[BR]]

  __'''Functions'''__ [[BR]]

  [''retVal'', ''err''] = '''rpLibGetDouble(''' ''libHandle'', ''path'' ''')''' [[BR]]
  [''retStr'', ''err''] = '''rpLibGetString(''' ''libHandle'', ''path'' ''')''' [[BR]]

  [''err''] = '''rpLibPutDouble(''' ''libHandle'', ''path'', ''value'', ''append'' ''')''' [[BR]]
  [''err''] = '''rpLibPutString(''' ''libHandle'', ''path'', ''value'', ''append'' ''')''' [[BR]]
  [''err''] = '''rpLibPutFile(''' ''libHandle'', ''path'', ''fileName'', ''compress'', ''append'') [[BR]]

  [''retStr'', ''err''] = '''rpLibXml(''' ''lib'' ''')''' [[BR]]
  [''err''] = '''rpLibResult(''' ''lib'' ''')''' [[BR]]


'''Units''' Class [[BR]]

  These functions provide an interface to the Rappture Units library.


  __'''Functions'''__ [[BR]]

  [''retVal'', ''result''] = '''rpUnitsConvertDbl(''' ''fromVal'', ''toUnitsName'' ''')''' [[BR]]
  [''retStr'', ''result''] = '''rpUnitsConvertStr(''' ''fromVal'', ''toUnitsName'', ''showUnits'' ''')''' [[BR]]


'''Utils''' Module [[BR]]

  These functions provide an interface to the Rappture Utils library.

  __'''Functions'''__ [[BR]]

  [''err''] = '''rpUtilsProgress(''' ''percent'', ''message'' ''')''' [[BR]]



------------------------------------------------------------------------------------- [[BR]]

Code Synopsis & Examples: [[BR]] [[BR]]


[''libHandle'', ''err'']  = '''rpLib(''' ''path'' ''')'''

  Purpose:[[BR]]
Use the xml file located at ''path'' to create a Rappture Library Object [[BR]]

  Input Arguments: [[BR]]
1. ''path'' - non-null c style string providing the path to an xml file[[BR]]

  Return Value:[[BR]]
1. ''libHandle'' - Handle for a Rappture Library object.
2. ''err'' - Error flag 

  Notes: [[BR]]
1. On success ''libHandle'' will be a positive integer and ''err'' will be 0. [[BR]]
2. ''path'' must be a non-null c-style string [[BR]]

{{{

/*
  Example contents of driver.xml file
  <run>
      <input>
          <number id="temperature">
              <units>K</units>
              <default>300K</default>
              <current>300K</current>
          </number>
      </input>
  </run>
*/

infile = 'driver.xml';
[libHandle,err] = rpLib(infile);

quit;

/*
Result:
libHandle = 80502d0
*/

}}}