Changeset 154 for trunk/src/matlab/rpUnitsConvertStr.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/rpUnitsConvertStr.cc (modified) (1 diff)

trunk/src/matlab/rpUnitsConvertStr.cc

@@ -15 +15 @@
 
 #include "RpMatlabInterface.h"
+
+/**********************************************************************/
+// METHOD: [retStr,err] = rpUnitsConvertStr(fromVal,toUnitsName,showUnits)
+/// Convert between RpUnits return a string value with or without units
+/**
+ * Convert the value and units in the string @var{fromVal} to units specified
+ * in string @var{toUnitsName}. If @var{showUnits} is set to 1, then show the
+ * units in the returned string @var{retStr}, else leave the units off.
+ * The second return value @var{err} specifies whether there was an error
+ * during conversion.
+ * Error code, err=0 on success, anything else is failure.
+ */
 
 void mexFunction(int nlhs, mxArray *plhs[],