Changeset 1586 for trunk/examples/objects/api/cpp/number

Timestamp:

Oct 23, 2009, 7:56:25 AM (15 years ago)

Author:

dkearney

Message:

updating potential apis for c cpp and python. adding random() and diff()
functions to the rappture objects. objects should be able to generate a random
value for itself based on how it was configured. objects should be able to
compare itself with another object and tell us what the differences are.

File:

• trunk/examples/objects/api/cpp/number (modified) (2 diffs)

trunk/examples/objects/api/cpp/number

@@ -58 +58 @@
     double value(const char *units) const;
     void vvalue(void *storage, size_t numHints, va_list arg) const;
+    void random();
+    Rp_Chain *diff(const Object& o);
 
     Number& addPreset(const char *label, const char *desc,
@@ -334 +336 @@
                 va_list arg. Values stored in the object are
                 not changed.
+    Code Example:
+
+void random();
+    Purpose: populate the object with a random value
+    Input Arguments: 0
+    Return Value: None
+    Notes: the current value of this object will be populated
+           with a random value that fits within the min and
+           max if they were specified.
+    Code Example:
+
+Rp_Chain *diff(const Rp_Object &o);
+    Purpose: return a linked list showing the differences between
+             this object and Rp_Object &o
+    Input Arguments: 1
+        1. const Rp_Object &o - object to diff against
+    Return Value: list of differences between objects
+    Notes: None
     Code Example: