Changes between Version 9 and Version 10 of rappture_java_api

Timestamp:

Jan 31, 2011 3:09:56 PM (13 years ago)

Author:

braffert

Comment:

--

rappture_java_api

@@ -25 +25 @@
 __'''Method Summary'''__
 
-  void '''finalize()'''
-
   String '''get(''' String ''path'' ''')'''
 
@@ -45 +43 @@
   void '''putData(''' String ''path'', byte[] ''value'' ''')'''
 
-  void '''putDouble(''' String ''path'', double ''value'' ''')'''
-
   void '''putFile(''' String ''path'', String ''filename'', boolean ''compress'', boolean ''append'' ''')'''
 
@@ -52 +48 @@
 
   void '''putFile(''' String ''path'', String ''filename'' ''')'''
-
-  void '''putString(''' String ''path'', String ''value'', boolean ''append'' ''')'''
-
-  void '''putString(''' String ''path'', String ''value'' ''')'''
 
   void '''result(''' int ''exitStatus'' ''')'''
@@ -129 +121 @@
 __'''Method Detail'''__
 
-  protected void '''finalize()''' throws Throwable
-
-    Purpose:
-  
-      Deletes the underlying C++ !RpLibrary instance.  This method is called automatically by the garbage collector when there are no references to the Java Library instance.
-
   public String '''get(''' String ''path'' ''')'''
 
@@ -352 +338 @@
       2)  ''value'' - Data to store in the library object.
 
-  public void '''putDouble(''' String ''path'', double ''value'' ''')'''
-
-    Purpose:
-
-      Places ''value'' into the library at the xml location ''path''.  If the ''append'' flag is set to 1, then ''value'' will be appended to data that already exists at ''path''. If the ''append'' flag is set to false, then ''value'' will overwrite data that may have existed at ''path''.
-
-    Input Arguments:
-
-      1)  ''path'' - xml path (location) to store ''value''.
-
-      2)  ''value'' - Data to store in the library object.
-
-      3)  ''append'' - Append flag. If set to false, data at ''path'' will be overwritten. If set to true, new data will be appended to the existing data.
+  public void '''putFile(''' String ''path'', String ''filename'', boolean ''compress'', boolean ''append'' ''')'''
+
+    Purpose:
+
+      Places the contents of the file ''filename'' into the library at the xml location ''path''.  If the ''append'' flag is set to 1, then ''value'' will be appended to data that already exists at ''path''. If the ''append'' flag is set to false, then ''value'' will overwrite data that may have existed at ''path''.
+
+    Input Arguments:
+
+      1)  ''path'' - xml path (location) to store ''value''.
+
+      2)  ''filename'' - Name of the file to be stored.
+
+      3)  ''compress'' - Set to true to indicate that the binary data should be compressed.
+
+      4)  ''append'' - Append flag. If set to false, data at ''path'' will be overwritten. If set to true, new data will be appended to the existing data.
+
+  public void '''putFile(''' String ''path'', String ''filename'', boolean ''compress'' ''')'''
+
+    Purpose:
+
+      Places the contents of the file ''filename'' into the library at the xml location ''path''.  Overwrites any data that previously existed at path. Equivalent to putFile(''path'', ''value'', ''compress'', false).
+
+    Input Arguments:
+
+      1)  ''path'' - xml path (location) to store ''value''.
+
+      2)  ''filename'' - Name of the file to be stored.
+          
+      3)  ''compress'' - Set to true to indicate that the binary data should be compressed.
+
+  public void '''putFile(''' String ''path'', String ''filename'' ''')'''
+
+    Purpose:
+
+      Places the contents of the file ''filename'' into the library at the xml location ''path''.  Binary data is automatically compressed.  Overwrites any data that previously existed at path. Equivalent to putFile(''path'', ''value'', true, false).
+
+    Input Arguments:
+
+      1)  ''path'' - xml path (location) to store ''value''.
+
+      2)  ''filename'' - Name of the file to be stored.
+
+  public void '''result(''' int ''exitStatus'' ''')'''
+
+    Purpose:
+
+      Write the data from Library object instance to file and signal the end of processing to the graphical user interface.
+
+    Input Arguments:
+
+      1)  ''exitStatus'' - Integer representing the success or failure of the application. 0 for success, any other number is failure.
 
 {{{
@@ -384 +408 @@
     String Ef;
     rappture.Library driver = new rappture.Library("driver.xml");
-    driver.put("input.number(Ef).current", 12.345);
+    driver.put("input.number(Ef).current", "6eV");
     Ef = driver.get("input.number(Ef).current");
     System.out.println("Ef = " + Ef);
+    driver.result(0);
     System.exit(0);
   }
@@ -393 +418 @@
 # Result:
 #
-# Ef = 12.345
-}}}
-
-  public void '''putFile(''' String ''path'', String ''filename'', boolean ''compress'', boolean ''append'' ''')'''
-
-    Purpose:
-
-      Places the contents of the file ''filename'' into the library at the xml location ''path''.  If the ''append'' flag is set to 1, then ''value'' will be appended to data that already exists at ''path''. If the ''append'' flag is set to false, then ''value'' will overwrite data that may have existed at ''path''.
-
-    Input Arguments:
-
-      1)  ''path'' - xml path (location) to store ''value''.
-
-      2)  ''filename'' - Name of the file to be stored.
-
-      3)  ''compress'' - Set to true to indicate that the binary data should be compressed.
-
-      4)  ''append'' - Append flag. If set to false, data at ''path'' will be overwritten. If set to true, new data will be appended to the existing data.
-
-  public void '''putFile(''' String ''path'', String ''filename'', boolean ''compress'' ''')'''
-
-    Purpose:
-
-      Places the contents of the file ''filename'' into the library at the xml location ''path''.  Overwrites any data that previously existed at path. Equivalent to putFile(''path'', ''value'', ''compress'', false).
-
-    Input Arguments:
-
-      1)  ''path'' - xml path (location) to store ''value''.
-
-      2)  ''filename'' - Name of the file to be stored.
-          
-      3)  ''compress'' - Set to true to indicate that the binary data should be compressed.
-
-  public void '''putFile(''' String ''path'', String ''filename'' ''')'''
-
-    Purpose:
-
-      Places the contents of the file ''filename'' into the library at the xml location ''path''.  Binary data is automatically compressed.  Overwrites any data that previously existed at path. Equivalent to putFile(''path'', ''value'', true, false).
-
-    Input Arguments:
-
-      1)  ''path'' - xml path (location) to store ''value''.
-
-      2)  ''filename'' - Name of the file to be stored.
-
-  public void '''putString(''' String ''path'', String ''value'', boolean ''append'' ''')'''
-
-    Purpose:
-
-      Place the string ''value'' into the library at the xml location ''path''. If the ''append'' flag is set to 1, then ''value'' will be appended to data that already exists at ''path''. If the ''append'' flag is set to false, then ''value'' will overwrite data that may have existed at ''path''.  Similar to put(''path'', ''value'', ''append''), except only Strings are accepted for ''value''.
-
-    Input Arguments:
-
-      1)  ''path'' - xml path (location) to store ''value''.
-
-      2)  ''value'' - Data to store in the library.
-
-      3)  ''append'' - Append flag. If set to false, data at ''path'' will be overwritten. If set to true, new data will be appended to the existing data.
-
-  public void '''putString(''' String ''path'', String ''value'' ''')'''
-
-    Purpose:
-
-      Place the string ''value'' into the library at the xml location path. Overwrites any data that previously existed at path. Equivalent to putString(''path'', ''value'', ''false'').
-
-    Input Arguments:
-
-      1)  ''path'' - xml path (location) to store ''value''.
-
-      2)  ''value'' - Data to store in the library.
-
-
-  public void '''result(''' int ''exitStatus'' ''')'''
-
-    Purpose:
-
-      Write the data from Library object instance to file and signal the end of processing to the graphical user interface.
-
-    Input Arguments:
-
-      1)  ''exitStatus'' - Integer representing the success or failure of the application. 0 for success, any other number is failure.
+# A run.xml file is created and the Rappture graphical user Interface is signaled that processing has ended.
+}}}
+
+  public void '''result()'''
+
+    Purpose:
+
+      Write the data from Library object instance to file and signal the end of processing to the graphical user interface.  Equivalent to result(0).
+
+  public String '''xml()'''
+
+    Purpose:
+
+      Provides the entire xml of the Library.
+
+    Return Value:
+      
+      Returns a String object containing the entire xml of the Library.
+
+      
+== Units Class Detail ==
+
+__'''Method Detail'''__
+
+  public double '''convertDouble(''' String ''fromVal'', String ''to'' ''')'''
+
+    Purpose:
+
+      Returns the decimal value of the String ''fromVal'' in units given by the String ''to''.  Equivalent to Double.valueOf(convertString(fromVal, to, false)).
+
+    Input Arguments:
+
+      1)  ''fromVal'' - String with numeric portion as well as optional units (for example: "3m" or "3").
+
+      2)  ''to'' - String name of the units to convert to.
+
+    Return Value:
+
+      Decimal value of ''fromVal'' in units specified by ''to''.
+
+  public String '''convertString(''' String ''fromVal'', String ''to'', boolean ''units'' ''')'''
+
+    Purpose:
+
+      Returns a String containing the value of the String ''fromVal'' in units given by the String ''to''.  Units are appended to the result if the ''units'' flag is true.
+
+    Input Arguments:
+
+      1)  ''fromVal'' - String with the numeric portion as well as optional units (for example: "3m" or "3").
+
+      2)  ''to'' - String name of the units to convert to.
+
+      3)  ''units'' - Flag to indicate whether or not units should be included in the output String.
+
+    Return Value:
+
+      String containing the converted value of ''fromVal'' in units specified by ''to'' with optional units.
 
 {{{
@@ -491 +492 @@
 class Example{
   public static void main(String args[]){
-    String Ef;
-    rappture.Library driver = new rappture.Library("driver.xml");
-    driver.put("input.number(Ef).current", "6eV");
-    Ef = driver.get("input.number(Ef).current");
-    System.out.println("Ef = " + Ef);
-    driver.result(0);
-    System.exit(0);
-  }
-}
-
-# Result:
-#
-# A run.xml file is created and the Rappture graphical user Interface is signaled that processing has ended.
-}}}
-
-  public void '''result()'''
-
-    Purpose:
-
-      Write the data from Library object instance to file and signal the end of processing to the graphical user interface.  Equivalent to result(0).
-
-  public String '''xml()'''
-
-    Purpose:
-
-      Provides the entire xml of the Library.
-
-    Return Value:
-      
-      Returns a String object containing the entire xml of the Library.
-
-      
-== Units Class Detail ==
-
-__'''Method Detail'''__
-
-  public double '''convertDouble(''' String ''fromVal'', String ''to'' ''')'''
-
-    Purpose:
-
-      Returns the decimal value of the String ''fromVal'' in units given by the String ''to''.  Equivalent to Double.valueOf(convertString(fromVal, to, false)).
-
-    Input Arguments:
-
-      1)  ''fromVal'' - String with numeric portion as well as optional units (for example: "3m" or "3").
-
-      2)  ''to'' - String name of the units to convert to.
-
-    Return Value:
-
-      Decimal value of ''fromVal'' in units specified by ''to''.
-
-  public String '''convertString(''' String ''fromVal'', String ''to'', boolean ''units'' ''')'''
-
-    Purpose:
-
-      Returns a String containing the value of the String ''fromVal'' in units given by the String ''to''.  Units are appended to the result if the ''units'' flag is true.
-
-    Input Arguments:
-
-      1)  ''fromVal'' - String with the numeric portion as well as optional units (for example: "3m" or "3").
-
-      2)  ''to'' - String name of the units to convert to.
-
-      3)  ''units'' - Flag to indicate whether or not units should be included in the output String.
-
-    Return Value:
-
-      String containing the converted value of ''fromVal'' in units specified by ''to'' with optional units.
-
-{{{
-# Contents of driver.xml
-# <run>
-#     <input>
-#         <number id="Ef">
-#             <units>eV</units>
-#             <min>-10eV</min>
-#             <max>10eV</max>
-#             <default>0eV</default>
-#             <current>3eV</current>
-#         </number>
-#     </input>
-# </run>
-
-class Example{
-  public static void main(String args[]){
     String result;
     double resultD;