Data read optimizations

[libplp.git] / src / SensorDevice.hh

diff --git a/src/SensorDevice.hh b/src/SensorDevice.hh
index b6830344bfd516270392c6bc86fc0807e69ec0d5..852c8706316956ffd68729abdfbf553c6e96e081 100644 (file)
--- a/src/SensorDevice.hh
+++ b/src/SensorDevice.hh
@@ -16,12 +16,24 @@
 using namespace plp;
 
 namespace plp {
+       /**
+        * This class defines methods for Device which can return and collect data.
+        */
        class SensorDevice : public Device {
                public:
                        SensorDevice(std::string id_param, std::string type_param) : Device(id_param, type_param) {}
                        virtual ~SensorDevice() {}
-                       virtual const DataReader *get_device_data() = 0;
+                       /*
+                        * Returns DataReader class for the device.
+                        */
+                       virtual const DataReader *get_datareader() = 0;
+                       /**
+                        * Returns the unit used by the device data.
+                        */
                        virtual string get_unit() = 0;
+                       /*
+                        * Returns latest data that is available for the device.
+                        */
                        virtual plp::Data *get_data() = 0;
        };
 }