Finish CaliperSensorBase

dcdbpusher/sensors/caliper/CaliperSensorBase.h

@@ -29,6 +29,19 @@
  * @ingroup  pusherplugins
  *
  * @brief Listen for data sent by Caliper framework.
+ *
+ * @details This plugin is an odd one out to accommodate Caliper. It uses UNIX
+ *          sockets to receive data (function or event names and corresponding
+ *          timestamp). It does not periodically poll data but instead checks if
+ *          new data is available at the socket. If data is produced faster by
+ *          Caliper than it can be consumed by this plugin at its current
+ *          frequency data will be consequently lost. Sensors are not
+ *          constructed at program start (during configuration) but during
+ *          runtime. For each new encountered function/event name a new sensor
+ *          is created whose name identifies the function/event. On subsequent
+ *          encounters a value of 1 is pushed for the corresponding sensor.
+ *          Aggregated numbers of encountered function/event names can be
+ *          evaluated afterwards from the database.
  */
 
 #ifndef CALIPER_CALIPERSENSORBASE_H_
@@ -36,69 +49,36 @@
 
 #include "sensorbase.h"
 
-/* 
- *  TODO
- *  Add plugin specific includes
- */
-
 /**
- * @brief SensorBase specialization for this plugin.
- *
- * @ingroup cali
- */
+* @brief SensorBase specialization for this plugin.
+*
+* @ingroup cali
+*/
 class CaliperSensorBase : public SensorBase {
 public:
-	CaliperSensorBase(const std::string& name) :
-		SensorBase(name) {
-		/*
-		 * 	TODO
-		 *  Initialize plugin specific attributes
-		 */
-	}
-	
-	CaliperSensorBase(const CaliperSensorBase& other) :
-		SensorBase(other) {
-		/*
-		 * 	TODO
-		 *  Copy construct plugin specific attributes
-		 */
-	}
+    CaliperSensorBase(const std::string& name) :
+    SensorBase(name) {
+    }
+
+    CaliperSensorBase(const CaliperSensorBase& other) :
+    SensorBase(other) {
+    }
+
+    virtual ~CaliperSensorBase() {
+    }
+
+    CaliperSensorBase& operator=(const CaliperSensorBase& other) {
+        SensorBase::operator=(other);
 
-	virtual ~CaliperSensorBase() {
-		/*
-		 * 	TODO
-		 *  If necessary, deconstruct plugin specific attributes
-		 */
-	}
-	
-	CaliperSensorBase& operator=(const CaliperSensorBase& other) {
-	  SensorBase::operator=(other);
-	  /*
-		 * 	TODO
-		 *  Implement assignment operator for plugin specific attributes
-		 */
-		 
-		 return *this;
-	}
+        return *this;
+    }
 
-	/*
-	 * 	TODO
-	 *  Getters and Setters for plugin specific attributes
-	 */
-	 
-  void printConfig(LOG_LEVEL ll, LOGGER& lg) {
-    /*
-		 * 	TODO
-		 *  Log attributes here for debug reasons
-		 */
-    LOG_VAR(ll) << "     NumSpacesAsIndention: " << 5;
-  }
+    void printConfig(LOG_LEVEL ll, LOGGER& lg) {
+        /* nothing to print */
+    }
 
 protected:
-	/*
-	 * 	TODO
-	 *  Add plugin specific attributes here
-	 */
+    // no specific attributes
 
 };