Struct design for PointParametricEst

Author: Affie

src/entities/DFGVariable.jl

@@ -63,26 +63,28 @@ mutable struct PackedVariableNodeData
                          x15::Bool ) = new(x1,x2,x3,x4,x5,x6,x7,x8,x9,x10,x11,x12,x13,x14,x15)
 end
 
-
-abstract type AbstractVariableEstimate end
+# AbstractPointParametricEst interface
+abstract type AbstractPointParametricEst end
 """
     $TYPEDEF
 
-Data container to store Parameteric Point Estimate (PPE) from a variety of types.
-
-Notes
-- `ppeType` is something like `:max/:mean/:modefit` etc.
-- `solveKey` is from super-solve concept, starting with `:default`,
-- `estimate` is the actual numerical estimate value,
-- Additional information such as how the data is represented (ie softtype) is stored alongside this data container in the `DFGVariableSummary` container.
+Data container to store Parameteric Point Estimate (PPE) for mean and max.
 """
-struct VariableEstimate <: AbstractVariableEstimate
-  solverKey::Symbol
-  ppeType::Symbol
-  estimate::Vector{Float64}
-  lastUpdatedTimestamp::DateTime
+struct MeanMaxEst <: AbstractPointParametricEst
+    solverKey::Symbol #repeated because of Sam's request
+    max::Vector{Float64}
+    mean::Vector{Float64}
+    lastUpdatedTimestamp::DateTime
 end
-VariableEstimate(solverKey::Symbol, type::Symbol, estimate::Vector{Float64}) = VariableEstimate(solverKey, type, estimate, now())
+MeanMaxEst(solverKey::Symbol,max::Vector{Float64},mean::Vector{Float64}) = MeanMaxEst(solverKey, max, mean, now())
+
+getMaxEstimate(est::AbstractPointParametricEst) = est.max
+getMeanEstimate(est::AbstractPointParametricEst) = est.mean
+getLastUpdatedTimestamp(est::AbstractPointParametricEst) = est.lastUpdatedTimestamp
+
+
+VariableEstimate(params...) = errror("VariableEstimate is depreciated, please use MeanMaxEst")
+
 
 """
     $(TYPEDEF)
@@ -93,7 +95,7 @@ mutable struct DFGVariable <: AbstractDFGVariable
     label::Symbol
     timestamp::DateTime
     tags::Vector{Symbol}
-    estimateDict::Dict{Symbol, Dict{Symbol, <: AbstractVariableEstimate}}
+    estimateDict::Dict{Symbol, <: AbstractVariableEstimate}
     solverDataDict::Dict{Symbol, VariableNodeData}
     smallData::Dict{String, String}
     bigData::Dict{Symbol, AbstractBigDataEntry}
@@ -138,12 +140,7 @@ solverData(v::DFGVariable, key::Symbol=:default) = haskey(v.solverDataDict, key)
 Retrieve data structure stored in a variable.
 """
 function getData(v::DFGVariable; solveKey::Symbol=:default)::VariableNodeData
-  #FIXME but back in later, it just slows everything down
-  if !(@isdefined getDataWarnOnce)
-    @warn "getData is deprecated, please use solverData(), future warnings in getData is suppressed"
-    global getDataWarnOnce = true
-  end
-  # @warn "getData is deprecated, please use solverData()"
+  @warn "getData is deprecated, please use solverData()"
   return v.solverDataDict[solveKey]
 end
 """
@@ -166,7 +163,7 @@ mutable struct DFGVariableSummary <: AbstractDFGVariable
     label::Symbol
     timestamp::DateTime
     tags::Vector{Symbol}
-    estimateDict::Dict{Symbol, Dict{Symbol, <:AbstractVariableEstimate}}
+    estimateDict::Dict{Symbol, <:AbstractVariableEstimate}
     softtypename::Symbol
     _internalId::Int64
 end