add comment and reformat

griddb · Mar 18, 2019 · ab88e6d · ab88e6d
1 parent 664d5a5
commit ab88e6d
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/src/PartitionController.cpp b/src/PartitionController.cpp
@@ -51,7 +51,7 @@ namespace griddb {
      */
     int64_t PartitionController::get_container_count(int32_t partition_index) {
         int64_t value;
-        GSResult ret = gsGetPartitionContainerCount(mController, partition_index,&value);
+        GSResult ret = gsGetPartitionContainerCount(mController, partition_index, &value);
 
         // Check ret, if error, throw exception
         if (ret != GS_RESULT_OK) {

diff --git a/src/TimeSeriesProperties.cpp b/src/TimeSeriesProperties.cpp
@@ -27,23 +27,41 @@ namespace griddb {
     }
     TimeSeriesProperties::~TimeSeriesProperties() {
     }
+    /*
+     * Set attribute: mTsProps.rowExpirationTime & mTsProps.rowExpirationTimeUnit
+     */
     void TimeSeriesProperties::set_row_expiration_time(int elapsedTime,
             GSTimeUnit timeUnit) {
         mTsProps.rowExpirationTime = elapsedTime;
         mTsProps.rowExpirationTimeUnit = timeUnit;
     }
+    /*
+     * Set attribute: mTsProps.expirationDivisionCount
+     */
     void TimeSeriesProperties::set_expiration_division_count(int count) {
         mTsProps.expirationDivisionCount = count;
     }
+    /*
+     * Get attribute: mTsProps.rowExpirationTime
+     */
     int TimeSeriesProperties::get_row_expiration_time() {
         return mTsProps.rowExpirationTime;
     }
+    /*
+     * Get attribute: mTsProps.rowExpirationTimeUnit
+     */
     GSTimeUnit TimeSeriesProperties::get_row_expiration_time_unit() {
         return mTsProps.rowExpirationTimeUnit;
     }
+    /*
+     * Get attribute: mTsProps.expirationDivisionCount
+     */
     int TimeSeriesProperties::get_expiration_division_count() {
         return mTsProps.expirationDivisionCount;
     }
+    /*
+     * Get attribute: mTsProps
+     */
     GSTimeSeriesProperties* TimeSeriesProperties::gs_ptr() {
         return &mTsProps;
     }

diff --git a/src/TimeSeriesProperties.h b/src/TimeSeriesProperties.h
@@ -22,16 +22,17 @@
 namespace griddb {
 
 class TimeSeriesProperties {
-    GSTimeSeriesProperties mTsProps;
+    private:
+        GSTimeSeriesProperties mTsProps;
 
     public:
         TimeSeriesProperties(const GSTimeSeriesProperties* timeSeriesProps);
         TimeSeriesProperties(int32_t elapsedTime, GSTimeUnit timeUnit, int32_t ExpirationDivisionCount);
         ~TimeSeriesProperties();
-
+        // APIs to set values for expiration_time and expiration_division_count
         void set_row_expiration_time(int32_t elapsedTime, GSTimeUnit timeUnit);
         void set_expiration_division_count(int32_t count);
-
+        // APIs to get values of expiration_time, expiration_time_unit, expiration_division_count and TimeSeriesProperties
         int get_row_expiration_time();
         GSTimeUnit get_row_expiration_time_unit();
         int get_expiration_division_count();