Changeset 154 for trunk/src/matlab/rpUnitsDefineUnit.cc

Timestamp:

Jan 11, 2006, 3:55:15 PM (19 years ago)

Author:

dkearney

Message:

modified matlab bindings and tests.
includes all popular functions available in RpLibrary? and RpUnits
compile and run, but not all tests work as they should
some of these functions will be removed soon because the id field is
no longer a valid argument. path ids should be incorporated in paths from now on.

File:

• trunk/src/matlab/rpUnitsDefineUnit.cc (modified) (5 diffs)

trunk/src/matlab/rpUnitsDefineUnit.cc

@@ -3 +3 @@
  *  INTERFACE: Matlab Rappture Library Source
  *
- *    [unitsHandle] = rpUnitsDefineUnit(unitSymbol, basisHandle)
+ *    [unitsHandle,err] = rpUnitsDefineUnit(unitSymbol, basisHandle)
  *
  * ======================================================================
@@ -16 +16 @@
 #include "RpMatlabInterface.h"
 
+/**********************************************************************/
+// METHOD: [unitsHandle,err] = rpUnitsDefineUnit(unitSymbol, basisHandle)
+/// Define a new Rappture Units type.
+/**
+ * Define a new Rappture Units type which can be searched for using
+ * @var{unitSymbol} and has a basis of @var{basisHandle}. Because of
+ * the way the Rappture Units module parses unit names, complex units must
+ * be defined as multiple basic units. See the RpUnits Howto for more
+ * information on this topic. A @var{basisHandle} equal to 0 means that
+ * the unit being defined should be considered as a basis. Unit names must
+ * not be empty strings.
+ *
+ * The first return value, @var{unitsHandle} represents the handle of the
+ * instance of the RpUnits object inside the internal dictionary. On
+ * success this value will be greater than zero (0), any other value is
+ * represents failure within the function. The second return value
+ * @var{err} represents the error code returned from the function.
+ *
+ * Error code, err=0 on success, anything else is failure.
+ */
+
 void mexFunction(int nlhs, mxArray *plhs[],
                  int nrhs, const mxArray *prhs[])
@@ -25 +46 @@
     int basisHandle = 0;
     int retIndex = 0;
+    int err = 1;
 
     /* Check for proper number of arguments. */
     if (nrhs != 2)
         mexErrMsgTxt("Two input required.");
-    else if (nlhs > 1)
+    else if (nlhs > 2)
         mexErrMsgTxt("Too many output arguments.");
 
@@ -45 +67 @@
         if (myUnit) {
             retHandle = storeObject_UnitsStr(myUnit->getUnitsName());
+            if (retHandle) {
+                err = 0;
+            }
         }
     }
@@ -50 +75 @@
     /* Set C-style string output_buf to MATLAB mexFunction output*/
     plhs[0] = mxCreateDoubleScalar(retHandle);
+    plhs[1] = mxCreateDoubleScalar(err);
 
     return;