diff include/Scope.h @ 485:506a319c08cf prerelease

Scope can now take a float* to an array instead of individual variables
author Giulio Moro <giuliomoro@yahoo.it>
date Tue, 21 Jun 2016 15:17:38 +0100
parents faa5f58c71af
children
line wrap: on
line diff
--- a/include/Scope.h	Tue Jun 21 15:16:55 2016 +0100
+++ b/include/Scope.h	Tue Jun 21 15:17:38 2016 +0100
@@ -16,8 +16,29 @@
     public:
         Scope();
         
+        /**
+         * Setup the Scope.
+         *
+         * @param numChannels number of channels in the scope.
+         * @param sampleRate sampleRate of the data passed in.
+         */
         void setup(unsigned int numChannels, float sampleRate);
+
+        /**
+         * Logs a frame of data to the scope.
+         *
+         * Pass one argument per channel (starting from the first), up to the
+         * number of channels of the object.
+         * Omitted values will be set to 0.
+         */
         void log(float chn1, ...);
+
+        /**
+         * Logs a frame of data to the scope.
+         *
+         * @param values a pointer to an array containing numChannels values.
+         */
+        void log(float* values);
         bool trigger();
         
     private:
@@ -83,4 +104,4 @@
         
 };
 
-#endif
\ No newline at end of file
+#endif