Marked most methods of the ZSwapObject class as const.

Author: xvitaly

src/lib/zswapobject/zswapobject.cpp

@@ -14,24 +14,24 @@
 
 #include "zswapobject/zswapobject.hpp"
 
-bool ZSwapObject::CheckPercent(const std::string& Value)
+bool ZSwapObject::CheckPercent(const std::string& Value) const
 {
     if (Value.empty()) return true;
     const int ValueInt = std::stoi(Value);
     return (ValueInt < 0) || (ValueInt > 100);
 }
 
-bool ZSwapObject::CheckEnabled(const std::string& Value)
+bool ZSwapObject::CheckEnabled(const std::string& Value) const
 {
     return !std::regex_match(Value, std::regex("^[YN]$"));
 }
 
-void ZSwapObject::WriteLogEntry(const std::string& Name, const std::string& Value)
+void ZSwapObject::WriteLogEntry(const std::string& Name, const std::string& Value) const
 {
     std::cout << std::vformat(ZSwapMessageLog, std::make_format_args(Name, Value)) << std::endl;
 }
 
-void ZSwapObject::WriteZSwapValue(const std::string& Name, const std::string& Value)
+void ZSwapObject::WriteZSwapValue(const std::string& Name, const std::string& Value) const
 {
     const std::string FullPath = ZSwapModuleParametersPath + Name;
     if (!std::filesystem::exists(FullPath)) throw std::runtime_error(std::vformat(ZSwapErrorKernel, std::make_format_args(Name)));
@@ -40,7 +40,7 @@ void ZSwapObject::WriteZSwapValue(const std::string& Name, const std::string& Va
     ZSwapSysFs.close();
 }
 
-std::string ZSwapObject::ReadZSwapValue(const std::string& Name)
+std::string ZSwapObject::ReadZSwapValue(const std::string& Name) const
 {
     const std::string FullPath = ZSwapModuleParametersPath + Name;
     if (!std::filesystem::exists(FullPath)) return "N/A";
@@ -51,115 +51,115 @@ std::string ZSwapObject::ReadZSwapValue(const std::string& Name)
     return Result;
 }
 
-std::string ZSwapObject::GetZSwapEnabled()
+std::string ZSwapObject::GetZSwapEnabled() const
 {
     return ReadZSwapValue(ZSwapEnabledName);
 }
 
-void ZSwapObject::SetZSwapEnabled(const std::string& Value)
+void ZSwapObject::SetZSwapEnabled(const std::string& Value) const
 {
     if (CheckEnabled(Value)) throw std::invalid_argument(std::vformat(ZSwapErrorBool, std::make_format_args(ZSwapEnabledName)));
     WriteLogEntry(ZSwapEnabledName, Value);
     WriteZSwapValue(ZSwapEnabledName, Value);
 }
 
-std::string ZSwapObject::GetZSwapSameFilledPages()
+std::string ZSwapObject::GetZSwapSameFilledPages() const
 {
     return ReadZSwapValue(ZSwapSameFilledPagesName);
 }
 
-void ZSwapObject::SetZSwapSameFilledPages(const std::string& Value)
+void ZSwapObject::SetZSwapSameFilledPages(const std::string& Value) const
 {
     if (CheckEnabled(Value)) throw std::invalid_argument(std::vformat(ZSwapErrorBool, std::make_format_args(ZSwapSameFilledPagesName)));
     WriteLogEntry(ZSwapSameFilledPagesName, Value);
     WriteZSwapValue(ZSwapSameFilledPagesName, Value);
 }
 
-std::string ZSwapObject::GetZSwapMaxPoolPercent()
+std::string ZSwapObject::GetZSwapMaxPoolPercent() const
 {
     return ReadZSwapValue(ZSwapMaxPoolPercentName);
 }
 
-void ZSwapObject::SetZSwapMaxPoolPercent(const std::string& Value)
+void ZSwapObject::SetZSwapMaxPoolPercent(const std::string& Value) const
 {
     if (CheckPercent(Value)) throw std::invalid_argument(std::vformat(ZSwapErrorRange, std::make_format_args(ZSwapMaxPoolPercentName)));
     WriteLogEntry(ZSwapMaxPoolPercentName, Value);
     WriteZSwapValue(ZSwapMaxPoolPercentName, Value);
 }
 
-std::string ZSwapObject::GetZSwapCompressor()
+std::string ZSwapObject::GetZSwapCompressor() const
 {
     return ReadZSwapValue(ZSwapCompressorName);
 }
 
-void ZSwapObject::SetZSwapCompressor(const std::string& Value)
+void ZSwapObject::SetZSwapCompressor(const std::string& Value) const
 {
     if (Value.empty()) throw std::invalid_argument(std::vformat(ZSwapErrorEmpty, std::make_format_args(ZSwapCompressorName)));
     WriteLogEntry(ZSwapCompressorName, Value);
     WriteZSwapValue(ZSwapCompressorName, Value);
 }
 
-std::string ZSwapObject::GetZSwapZpool()
+std::string ZSwapObject::GetZSwapZpool() const
 {
     return ReadZSwapValue(ZSwapZpoolName);
 }
 
-void ZSwapObject::SetZSwapZpool(const std::string& Value)
+void ZSwapObject::SetZSwapZpool(const std::string& Value) const
 {
     if (Value.empty()) throw std::invalid_argument(std::vformat(ZSwapErrorEmpty, std::make_format_args(ZSwapZpoolName)));
     WriteLogEntry(ZSwapZpoolName, Value);
     WriteZSwapValue(ZSwapZpoolName, Value);
 }
 
-std::string ZSwapObject::GetZSwapAcceptThresholdPercent()
+std::string ZSwapObject::GetZSwapAcceptThresholdPercent() const
 {
     return ReadZSwapValue(ZSwapAcceptThresholdPercentName);
 }
 
-void ZSwapObject::SetZSwapAcceptThresholdPercent(const std::string& Value)
+void ZSwapObject::SetZSwapAcceptThresholdPercent(const std::string& Value) const
 {
     if (CheckPercent(Value)) throw std::invalid_argument(std::vformat(ZSwapErrorRange, std::make_format_args(ZSwapAcceptThresholdPercentName)));
     WriteLogEntry(ZSwapAcceptThresholdPercentName, Value);
     WriteZSwapValue(ZSwapAcceptThresholdPercentName, Value);
 }
 
-std::string ZSwapObject::GetZSwapNonSameFilledPages()
+std::string ZSwapObject::GetZSwapNonSameFilledPages() const
 {
     return ReadZSwapValue(ZSwapNonSameFilledPagesName);
 }
 
-void ZSwapObject::SetZSwapNonSameFilledPages(const std::string& Value)
+void ZSwapObject::SetZSwapNonSameFilledPages(const std::string& Value) const
 {
     if (CheckEnabled(Value)) throw std::invalid_argument(std::vformat(ZSwapErrorBool, std::make_format_args(ZSwapNonSameFilledPagesName)));
     WriteLogEntry(ZSwapNonSameFilledPagesName, Value);
     WriteZSwapValue(ZSwapNonSameFilledPagesName, Value);
 }
 
-std::string ZSwapObject::GetZSwapExclusiveLoads()
+std::string ZSwapObject::GetZSwapExclusiveLoads() const
 {
     return ReadZSwapValue(ZSwapExclusiveLoadsName);
 }
 
-void ZSwapObject::SetZSwapExclusiveLoads(const std::string& Value)
+void ZSwapObject::SetZSwapExclusiveLoads(const std::string& Value) const
 {
     if (CheckEnabled(Value)) throw std::invalid_argument(std::vformat(ZSwapErrorBool, std::make_format_args(ZSwapExclusiveLoadsName)));
     WriteLogEntry(ZSwapExclusiveLoadsName, Value);
     WriteZSwapValue(ZSwapExclusiveLoadsName, Value);
 }
 
-std::string ZSwapObject::GetZSwapShrinkerEnabled()
+std::string ZSwapObject::GetZSwapShrinkerEnabled() const
 {
     return ReadZSwapValue(ZSwapShrinkerEnabledName);
 }
 
-void ZSwapObject::SetZSwapShrinkerEnabled(const std::string& Value)
+void ZSwapObject::SetZSwapShrinkerEnabled(const std::string& Value) const
 {
     if (CheckEnabled(Value)) throw std::invalid_argument(std::vformat(ZSwapErrorBool, std::make_format_args(ZSwapShrinkerEnabledName)));
     WriteLogEntry(ZSwapShrinkerEnabledName, Value);
     WriteZSwapValue(ZSwapShrinkerEnabledName, Value);
 }
 
-bool ZSwapObject::IsAvailable()
+bool ZSwapObject::IsAvailable() const
 {
     return std::filesystem::exists(ZSwapModuleParametersPath);
 }

src/lib/zswapobject/zswapobject.hpp

@@ -29,133 +29,133 @@ class ZSwapObject
      *  Gets the ZSwap enabled value.
      * @returns ZSwap enabled value.
     */
-    std::string GetZSwapEnabled();
+    std::string GetZSwapEnabled() const;
 
     /**
      *  Sets the ZSwap enabled value.
      * @param Value New value.
      * @exception Raises an instance of std::invalid_argument if cannot set
      * the proposed value.
     */
-    void SetZSwapEnabled(const std::string&);
+    void SetZSwapEnabled(const std::string&) const;
 
     /**
      *  Gets the same filled pages enabled value.
      * @returns Same filled pages enabled value.
     */
-    std::string GetZSwapSameFilledPages();
+    std::string GetZSwapSameFilledPages() const;
 
     /**
      *  Sets the same filled pages enabled value.
      * @param Value New value.
      * @exception Raises an instance of std::invalid_argument if cannot set
      * the proposed value.
     */
-    void SetZSwapSameFilledPages(const std::string&);
+    void SetZSwapSameFilledPages(const std::string&) const;
 
     /**
      *  Gets the maximum pool percentage value.
      * @returns Maximum pool percentage value.
     */
-    std::string GetZSwapMaxPoolPercent();
+    std::string GetZSwapMaxPoolPercent() const;
 
     /**
      *  Sets the maximum pool percentage value.
      * @param Value New value.
      * @exception Raises an instance of std::invalid_argument if cannot set
      * the proposed value.
     */
-    void SetZSwapMaxPoolPercent(const std::string&);
+    void SetZSwapMaxPoolPercent(const std::string&) const;
 
     /**
      *  Gets the compression algorithm name.
      * @returns Compression algorithm name.
     */
-    std::string GetZSwapCompressor();
+    std::string GetZSwapCompressor() const;
 
     /**
      *  Sets the compression algorithm name.
      * @param Value New value.
      * @exception Raises an instance of std::invalid_argument if cannot set
      * the proposed value.
     */
-    void SetZSwapCompressor(const std::string&);
+    void SetZSwapCompressor(const std::string&) const;
 
     /**
      *  Gets the kernel's zpool type.
      * @returns Kernel's zpool type.
     */
-    std::string GetZSwapZpool();
+    std::string GetZSwapZpool() const;
 
     /**
      *  Sets the kernel's zpool type.
      * @param Value New value.
      * @exception Raises an instance of std::invalid_argument if cannot set
      * the proposed value.
     */
-    void SetZSwapZpool(const std::string&);
+    void SetZSwapZpool(const std::string&) const;
 
     /**
      *  Gets the accept threshold percentage value.
      * @returns Accept threshold percentage value.
     */
-    std::string GetZSwapAcceptThresholdPercent();
+    std::string GetZSwapAcceptThresholdPercent() const;
 
     /**
      *  Sets the accept threshold percentage value.
      * @param Value New value.
      * @exception Raises an instance of std::invalid_argument if cannot set
      * the proposed value.
     */
-    void SetZSwapAcceptThresholdPercent(const std::string&);
+    void SetZSwapAcceptThresholdPercent(const std::string&) const;
 
     /**
      *  Gets the non same filled pages enabled value.
      * @returns Non same filled pages enabled value.
     */
-    std::string GetZSwapNonSameFilledPages();
+    std::string GetZSwapNonSameFilledPages() const;
 
     /**
      *  Sets the non same filled pages enabled value.
      * @param Value New value.
      * @exception Raises an instance of std::invalid_argument if cannot set
      * the proposed value.
     */
-    void SetZSwapNonSameFilledPages(const std::string&);
+    void SetZSwapNonSameFilledPages(const std::string&) const;
 
     /**
      *  Gets the exclusive loads enabled value.
      * @returns Exclusive loads enabled value.
     */
-    std::string GetZSwapExclusiveLoads();
+    std::string GetZSwapExclusiveLoads() const;
 
     /**
      *  Sets the exclusive loads enabled value.
      * @param Value New value.
      * @exception Raises an instance of std::invalid_argument if cannot set
      * the proposed value.
     */
-    void SetZSwapExclusiveLoads(const std::string&);
+    void SetZSwapExclusiveLoads(const std::string&) const;
 
     /**
      *  Gets the shrinker enabled value.
      * @returns Shrinker enabled value.
     */
-    std::string GetZSwapShrinkerEnabled();
+    std::string GetZSwapShrinkerEnabled() const;
 
     /**
      *  Sets the shrinker enabled value.
      * @param Value New value.
      * @exception Raises an instance of std::invalid_argument if cannot set
      * the proposed value.
     */
-    void SetZSwapShrinkerEnabled(const std::string&);
+    void SetZSwapShrinkerEnabled(const std::string&) const;
 
     /**
      *  Checks if the ZSwap module is loaded and available for use.
      * @returns ZSwap module availability.
     */
-    bool IsAvailable();
+    bool IsAvailable() const;
 private:
     /**
      *  Stores the ZSwap log message template.
@@ -237,7 +237,7 @@ class ZSwapObject
      * @param Name Name.
      * @param Value Value.
     */
-    void WriteZSwapValue(const std::string&, const std::string&);
+    void WriteZSwapValue(const std::string&, const std::string&) const;
 
     /**
      *  Reads the value of the ZSwap kernel module by specified name.
@@ -246,14 +246,14 @@ class ZSwapObject
      * the proposed value.
      * @returns Value.
     */
-    std::string ReadZSwapValue(const std::string&);
+    std::string ReadZSwapValue(const std::string&) const;
 
     /**
      *  Prints log entry to the standard output.
      * @param Name Parameter name.
      * @param Value Parameter value.
     */
-    void WriteLogEntry(const std::string&, const std::string&);
+    void WriteLogEntry(const std::string&, const std::string&) const;
 
     /**
      *  Checks if the value matches the specified criteria [0..100].
@@ -262,7 +262,7 @@ class ZSwapObject
      * @retval true If the value belongs to [0..100] range.
      * @retval false Otherwise.
     */
-    bool CheckPercent(const std::string&);
+    bool CheckPercent(const std::string&) const;
 
     /**
      *  Checks if the value matches the specified criteria (Y or N).
@@ -271,7 +271,7 @@ class ZSwapObject
      * @retval true If the value matches the specified criteria.
      * @retval false Otherwise.
     */
-    bool CheckEnabled(const std::string&);
+    bool CheckEnabled(const std::string&) const;
 };
 
 #endif // ZSWAPOBJECT_HPP