Changeset 1586 for trunk/examples/objects/api

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.

Location:

trunk/examples/objects/api

Files:

• c/number (modified) (2 diffs)
• c/plot (modified) (2 diffs)
• cpp/boolean (modified) (2 diffs)
• cpp/choice (modified) (2 diffs)
• cpp/curve (modified) (2 diffs)
• cpp/number (modified) (2 diffs)
• cpp/plot (modified) (2 diffs)
• python/library (added)
• python/number (added)
• python/plot (added)

trunk/examples/objects/api/c/number

@@ -59 +59 @@
     void Rp_NumberVValue(Rp_Number *num, void *storage, size_t numHints,
                          va_list arg) const;
+    void Rp_NumberRandom();
+    Rp_Chain *Rp_NumberDiff(const Rp_Object *o);
 
     void Rp_NumberAddPreset(Rp_Number *num, const char *label,
@@ -368 +370 @@
                 va_list arg. Values stored in the object are
                 not changed.
+    Code Example:
+
+void Rp_NumberRandom();
+    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 *Rp_NumberDiff(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:
 

trunk/examples/objects/api/c/plot

@@ -42 +42 @@
     void Rp_PlotVValue(Rp_Plot *p, void *storage, size_t numHints,
                        va_list arg) const;
+    void Rp_PlotRandom();
+    Rp_Chain *Rp_PlotDiff(Rp_Plot *o);
 
     void Rp_PlotConfigure(Rp_Plot *p, size_t as, ClientData c);
@@ -264 +266 @@
     Code Example:
 
+void Rp_PlotRandom();
+    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 *Rp_PlotDiff(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:
+
 void Rp_PlotConfigure(Rp_Plot *p, size_t as, ClientData c);
     Purpose: configure the object based on the data in "c".

trunk/examples/objects/api/cpp/boolean

@@ -46 +46 @@
 
     void vvalue(void *storage, size_t numHints, va_list arg) const;
+    void random();
+    Rp_Chain *diff(const Object& o);
 
     void configure(size_t as, ClientData c);
@@ -244 +246 @@
                 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:
 

trunk/examples/objects/api/cpp/choice

@@ -46 +46 @@
 
     void vvalue(void *storage, size_t numHints, va_list arg) const;
+    void random();
+    Rp_Chain *diff(const Object& o);
+
 
     Choice& addPreset(const char *label, const char *desc,
@@ -251 +254 @@
                 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:
 

trunk/examples/objects/api/cpp/curve

@@ -54 +54 @@
 
     void vvalue(void *storage, size_t numHints, va_list arg) const;
+    void random();
+    Rp_Chain *diff(const Object& o);
 
     void configure(size_t as, ClientData c);
@@ -281 +283 @@
     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:
+
 void configure(size_t as, ClientData c);
     Purpose: configure the object based on the data in "c".

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:
 

trunk/examples/objects/api/cpp/plot

@@ -45 +45 @@
 
     void vvalue(void *storage, size_t numHints, va_list arg) const;
+    void random();
+    Rp_Chain *diff(const Object& o);
 
     void configure(size_t as, ClientData c);
@@ -246 +248 @@
     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:
+
 void configure(size_t as, ClientData c);
     Purpose: configure the object based on the data in "c".