Skip to content

Commit

Permalink
Merge pull request #945 from frogonwheels/tidy-overrides-metrics
Browse files Browse the repository at this point in the history 
Metrics - Clarify which virtual methods are overridden
  • Loading branch information
@dexterbg
dexterbg committed Nov 11, 2023
2 parents 440dc7d + 945ea87 commit a27855b
Showing 1 changed file with 45 additions and 45 deletions.
90 changes: 45 additions & 45 deletions vehicle/OVMS.V3/main/ovms_metrics.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,12 +275,12 @@ class OvmsMetricBool : public OvmsMetric
{
public:
OvmsMetricBool(const char* name, uint16_t autostale=0, metric_unit_t units = Other, bool persist = false);
virtual ~OvmsMetricBool();
~OvmsMetricBool() override;

public:
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1);
virtual std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1);
float AsFloat(const float defvalue = 0, metric_unit_t units = Other);
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override;
std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override;
float AsFloat(const float defvalue = 0, metric_unit_t units = Other) override;
int AsBool(const bool defvalue = false);
#ifdef CONFIG_OVMS_SC_JAVASCRIPT_DUKTAPE
void DukPush(DukContext &dc, metric_unit_t units = Other) override;
Expand All @@ -289,10 +289,10 @@ class OvmsMetricBool : public OvmsMetric
void operator=(bool value) { SetValue(value); }
bool SetValue(std::string value, metric_unit_t units = Other) override;
bool SetValue(dbcNumber& value) override;
void operator=(std::string value) { SetValue(value); }
void Clear();
bool CheckPersist();
void RefreshPersist();
void operator=(std::string value) override { SetValue(value); }
void Clear() override;
bool CheckPersist() override;
void RefreshPersist() override;

protected:
bool m_value;
Expand All @@ -303,12 +303,12 @@ class OvmsMetricInt : public OvmsMetric
{
public:
OvmsMetricInt(const char* name, uint16_t autostale=0, metric_unit_t units = Other, bool persist = false);
virtual ~OvmsMetricInt();
~OvmsMetricInt() override;

public:
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1);
virtual std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1);
float AsFloat(const float defvalue = 0, metric_unit_t units = Other);
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override;
std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override;
float AsFloat(const float defvalue = 0, metric_unit_t units = Other) override;
int AsInt(const int defvalue = 0, metric_unit_t units = Other);
#ifdef CONFIG_OVMS_SC_JAVASCRIPT_DUKTAPE
void DukPush(DukContext &dc, metric_unit_t units = Other) override;
Expand All @@ -317,10 +317,10 @@ class OvmsMetricInt : public OvmsMetric
void operator=(int value) { SetValue(value); }
bool SetValue(std::string value, metric_unit_t units = Other) override;
bool SetValue(dbcNumber& value) override;
void operator=(std::string value) { SetValue(value); }
void Clear();
bool CheckPersist();
void RefreshPersist();
void operator=(std::string value) override { SetValue(value); }
void Clear() override;
bool CheckPersist() override;
void RefreshPersist() override;

protected:
int m_value;
Expand All @@ -331,12 +331,12 @@ class OvmsMetricFloat : public OvmsMetric
{
public:
OvmsMetricFloat(const char* name, uint16_t autostale=0, metric_unit_t units = Other, bool persist = false);
virtual ~OvmsMetricFloat();
~OvmsMetricFloat() override;

public:
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1);
virtual std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1);
float AsFloat(const float defvalue = 0, metric_unit_t units = Other);
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override;
std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override;
float AsFloat(const float defvalue = 0, metric_unit_t units = Other) override;
int AsInt(const int defvalue = 0, metric_unit_t units = Other);
#ifdef CONFIG_OVMS_SC_JAVASCRIPT_DUKTAPE
void DukPush(DukContext &dc, metric_unit_t units = Other) override;
Expand All @@ -345,10 +345,10 @@ class OvmsMetricFloat : public OvmsMetric
void operator=(float value) { SetValue(value); }
bool SetValue(std::string value, metric_unit_t units = Other) override;
bool SetValue(dbcNumber& value) override;
void operator=(std::string value) { SetValue(value); }
void Clear();
virtual bool CheckPersist();
virtual void RefreshPersist();
void operator=(std::string value) override { SetValue(value); }
void Clear() override;
bool CheckPersist() override;
void RefreshPersist() override;

protected:
float m_value;
Expand All @@ -359,17 +359,17 @@ class OvmsMetricString : public OvmsMetric
{
public:
OvmsMetricString(const char* name, uint16_t autostale=0, metric_unit_t units = Other, bool persist = false);
virtual ~OvmsMetricString();
~OvmsMetricString() override;

public:
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1);
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override;
#ifdef CONFIG_OVMS_SC_JAVASCRIPT_DUKTAPE
void DukPush(DukContext &dc, metric_unit_t units = Other) override;
#endif
bool SetValue(std::string value, metric_unit_t units = Other) override;
void operator=(std::string value) { SetValue(value); }
void Clear();
virtual bool IsString() { return true; };
void operator=(std::string value) override { SetValue(value); }
void Clear() override;
bool IsString() override { return true; };

protected:
OvmsMutex m_mutex;
Expand All @@ -389,12 +389,12 @@ class OvmsMetricBitset : public OvmsMetric
: OvmsMetric(name, autostale, units, false)
{
}
virtual ~OvmsMetricBitset()
~OvmsMetricBitset() override
{
}

public:
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1)
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override
{
if (!IsDefined())
return std::string(defvalue);
Expand All @@ -412,7 +412,7 @@ class OvmsMetricBitset : public OvmsMetric
return ss.str();
}

virtual std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1)
std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override
{
std::string json = "[";
json += AsString(defvalue, units, precision);
Expand All @@ -436,7 +436,7 @@ class OvmsMetricBitset : public OvmsMetric
}
return SetValue(n_value, units);
}
void operator=(std::string value) { SetValue(value); }
void operator=(std::string value) override { SetValue(value); }

std::bitset<N> AsBitset(const std::bitset<N> defvalue = std::bitset<N>(0), metric_unit_t units = Other)
{
Expand Down Expand Up @@ -504,12 +504,12 @@ class OvmsMetricSet : public OvmsMetric
: OvmsMetric(name, autostale, units, false)
{
}
virtual ~OvmsMetricSet()
~OvmsMetricSet() override
{
}

public:
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1)
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override
{
if (!IsDefined())
return std::string(defvalue);
Expand All @@ -524,7 +524,7 @@ class OvmsMetricSet : public OvmsMetric
return ss.str();
}

virtual std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1)
std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override
{
std::string json = "[";
json += AsString(defvalue, units, precision);
Expand All @@ -546,7 +546,7 @@ class OvmsMetricSet : public OvmsMetric
}
return SetValue(n_value, units);
}
void operator=(std::string value) { SetValue(value); }
void operator=(std::string value) override { SetValue(value); }

std::set<ElemType> AsSet(const std::set<ElemType> defvalue = std::set<ElemType>(), metric_unit_t units = Other)
{
Expand Down Expand Up @@ -656,7 +656,7 @@ class OvmsMetricVector : public OvmsMetric
ESP_LOGI(TAG, "persist %s = %s", m_name, AsUnitString().c_str());
}
}
virtual ~OvmsMetricVector()
~OvmsMetricVector() override
{
}

Expand Down Expand Up @@ -750,7 +750,7 @@ class OvmsMetricVector : public OvmsMetric
return true;
}

void RefreshPersist()
void RefreshPersist() override
{
if (m_persist && m_valuep_size && IsDefined())
{
Expand All @@ -761,7 +761,7 @@ class OvmsMetricVector : public OvmsMetric
}

public:
virtual std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1)
std::string AsString(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override
{
if (!IsDefined())
return std::string(defvalue);
Expand Down Expand Up @@ -812,7 +812,7 @@ class OvmsMetricVector : public OvmsMetric
return ElemAsString(n, defvalue, units, precision, true);
}

virtual std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1)
std::string AsJSON(const char* defvalue = "", metric_unit_t units = Other, int precision = -1) override
{
std::string json = "[";
json += AsString(defvalue, units, precision);
Expand All @@ -838,7 +838,7 @@ class OvmsMetricVector : public OvmsMetric
}
#endif

virtual bool SetValue(std::string value, metric_unit_t units = Other)
bool SetValue(std::string value, metric_unit_t units = Other) override
{
std::vector<ElemType, Allocator> n_value;
std::istringstream vs(value);
Expand All @@ -852,7 +852,7 @@ class OvmsMetricVector : public OvmsMetric
}
return SetValue(n_value, units);
}
void operator=(std::string value) { SetValue(value); }
void operator=(std::string value) override { SetValue(value); }

bool SetValue(const std::vector<ElemType, Allocator>& value, metric_unit_t units = Other)
{
Expand Down Expand Up @@ -1026,7 +1026,7 @@ class MetricCallbackEntry
{
public:
MetricCallbackEntry(std::string caller, MetricCallback callback);
virtual ~MetricCallbackEntry();
~MetricCallbackEntry();

public:
std::string m_caller;
Expand Down Expand Up @@ -1066,7 +1066,7 @@ class OvmsMetrics
{
public:
OvmsMetrics();
virtual ~OvmsMetrics();
~OvmsMetrics();

public:
void RegisterMetric(OvmsMetric* metric);
Expand Down

0 comments on commit a27855b

Please sign in to comment.