deprecate getLabelDict,setSolverParams, setDescription

Author: Affie

src/CloudGraphsDFG/services/CloudGraphsDFG.jl

@@ -36,10 +36,10 @@ end
 # Accessors
 getLabelDict(dfg::CloudGraphsDFG) = dfg.labelDict
 getDescription(dfg::CloudGraphsDFG) = dfg.description
-setDescription(dfg::CloudGraphsDFG, description::String) = dfg.description = description
+setDescription!(dfg::CloudGraphsDFG, description::String) = dfg.description = description
 getAddHistory(dfg::CloudGraphsDFG) = dfg.addHistory
 getSolverParams(dfg::CloudGraphsDFG) = dfg.solverParams
-function setSolverParams(dfg::CloudGraphsDFG, solverParams::T)::T where T <: AbstractParams
+function setSolverParams!(dfg::CloudGraphsDFG, solverParams::T)::T where T <: AbstractParams
     return dfg.solverParams = solverParams
 end
 

src/Deprecated.jl

@@ -156,3 +156,9 @@ function data(f::DFGFactor)::GenericFunctionNodeData
   @warn "data() is deprecated, please use getSolverData()"
   return f.data
 end
+
+
+getLabelDict(dfg::AbstractDFG) = error("getLabelDict is deprecated, consider using listing functions")
+
+setSolverParams(args...) = error("setSolverParams is deprecated, use setSolverParams!")
+setDescription(args...) = error("setSolverParams is deprecated, use setDescription!")

src/DistributedFactorGraphs.jl

@@ -91,7 +91,7 @@ export MeanMaxPPE
 # AbstractDFG Interface
 #--------
 export setSerializationModule!, getSerializationModule
-export getLabelDict, getDescription, setDescription, getAddHistory, getSolverParams, setSolverParams
+export getDescription, setDescription!, getAddHistory, getSolverParams, setSolverParams!
 export getUserData, setUserData!, getRobotData, setRobotData!, getSessionData, setSessionData!
 
 # Not sure these are going to work everywhere, TODO implement in cloud?
@@ -108,6 +108,7 @@ export getBiadjacencyMatrix
 export toDot, toDotFile
 # Deprecated
 export getAdjacencyMatrix, getAdjacencyMatrixSparse
+export getLabelDict, setSolverParams, setDescription
 #--------
 
 # File import and export

src/GraphsDFG/services/GraphsDFG.jl

@@ -16,14 +16,14 @@ end
 vertex_index(v::GraphsNode) = v.index
 
 # Accessors
-getLabelDict(dfg::GraphsDFG) = dfg.labelDict
-getDescription(dfg::GraphsDFG) = dfg.description
-setDescription(dfg::GraphsDFG, description::String) = dfg.description = description
-getAddHistory(dfg::GraphsDFG) = dfg.addHistory
-getSolverParams(dfg::GraphsDFG) = dfg.solverParams
-function setSolverParams(dfg::GraphsDFG, solverParams::T) where T <: AbstractParams
-    dfg.solverParams = solverParams
-end
+# getLabelDict(dfg::GraphsDFG) = dfg.labelDict
+# getDescription(dfg::GraphsDFG) = dfg.description
+# setDescription(dfg::GraphsDFG, description::String) = dfg.description = description
+# getAddHistory(dfg::GraphsDFG) = dfg.addHistory
+# getSolverParams(dfg::GraphsDFG) = dfg.solverParams
+# function setSolverParams(dfg::GraphsDFG, solverParams::T) where T <: AbstractParams
+#     dfg.solverParams = solverParams
+# end
 
 """
     $(SIGNATURES)

src/LightDFG/LightDFG.jl

@@ -6,10 +6,10 @@ using DocStringExtensions
 import ...DistributedFactorGraphs: AbstractDFG, DFGNode, AbstractDFGVariable, AbstractDFGFactor, AbstractDFGSummary, AbstractParams, NoSolverParams, DFGVariable, DFGFactor
 
 # import DFG functions to extend
-import ...DistributedFactorGraphs:  setSolverParams,
+import ...DistributedFactorGraphs:  setSolverParams!,
                                     getFactor,
-                                    setDescription,
-                                    getLabelDict,
+                                    setDescription!,
+                                    # getLabelDict,
                                     getUserData,
                                     setUserData!,
                                     getRobotData,

src/LightDFG/entities/LightDFG.jl

@@ -56,6 +56,18 @@ LightDFG{T}(g::FactorGraph{Int,DFGVariable,DFGFactor}=FactorGraph{Int,DFGVariabl
 LightDFG(g::FactorGraph{Int,DFGVariable,DFGFactor}=FactorGraph{Int,DFGVariable,DFGFactor}(); params::T=NoSolverParams(), kwargs...)  where T =
         LightDFG{T,DFGVariable,DFGFactor}(g; params=params, kwargs...)
 
+
+LigthDFG(description::String,
+         userId::String,
+         robotId::String,
+         sessionId::String,
+         userData::Dict{Symbol, String},
+         robotData::Dict{Symbol, String},
+         sessionData::Dict{Symbol, String},
+         solverParams::AbstractParams) =
+         LigthDFG(FactorGraph{Int,DFGVariable,DFGFactor}(), description, userId, robotId, sessionId, userData, robotData, sessionData, Symbol[], solverParams)
+
+
 # Fully depcrecate nodeCounter and labelDict
 # Base.propertynames(x::LightDFG, private::Bool=false) =
 #     (:g, :description, :userId, :robotId, :sessionId, :nodeCounter, :labelDict, :addHistory, :solverParams)

src/LightDFG/services/LightDFG.jl

@@ -1,16 +1,16 @@
 
 
-# Accessors
-getLabelDict(dfg::LightDFG) = copy(dfg.g.labels.sym_int)
-getDescription(dfg::LightDFG) = dfg.description
-setDescription(dfg::LightDFG, description::String) = dfg.description = description
-getAddHistory(dfg::LightDFG) = dfg.addHistory
-getSolverParams(dfg::LightDFG) = dfg.solverParams
-
-# setSolverParams(dfg::LightDFG, solverParams) = dfg.solverParams = solverParams
-function setSolverParams(dfg::LightDFG, solverParams::P) where P <: AbstractParams
-  dfg.solverParams = solverParams
-end
+# # Accessors
+# getLabelDict(dfg::LightDFG) = copy(dfg.g.labels.sym_int)
+# getDescription(dfg::LightDFG) = dfg.description
+# setDescription(dfg::LightDFG, description::String) = dfg.description = description
+# getAddHistory(dfg::LightDFG) = dfg.addHistory
+# getSolverParams(dfg::LightDFG) = dfg.solverParams
+#
+# # setSolverParams(dfg::LightDFG, solverParams) = dfg.solverParams = solverParams
+# function setSolverParams(dfg::LightDFG, solverParams::P) where P <: AbstractParams
+#   dfg.solverParams = solverParams
+# end
 
 function exists(dfg::LightDFG{P,V,F}, node::V) where {P <: AbstractParams, V <: AbstractDFGVariable, F <: AbstractDFGFactor}
     return haskey(dfg.g.variables, node.label)

src/services/AbstractDFG.jl

@@ -1,59 +1,89 @@
+## ===== Interface for an AbstractDFG =====
 
+# Standard recommended fields to implement for AbstractDFG
+# - `description::String`
+# - `userId::String`
+# - `robotId::String`
+# - `sessionId::String`
+# - `userData::Dict{Symbol, String}`
+# - `robotData::Dict{Symbol, String}`
+# - `sessionData::Dict{Symbol, String}`
+# - `solverParams::T<:AbstractParams`
+# - `addHistory::Vector{Symbol}`
+# AbstractDFG Accessors
 
-## ===== Interface for an AbstractDFG =====
+# Getters
+"""
+    $(SIGNATURES)
+"""
+getDFGInfo(dfg::AbstractDFG) = (dfg.description, dfg.userId, dfg.robotId, dfg.sessionId, dfg.userData, dfg.robotData, dfg.sessionData, dfg.solverParams)
 
 """
     $(SIGNATURES)
+"""
+getDescription(dfg::AbstractDFG) = dfg.description
 
-Deserialization of IncrementalInference objects require discovery of foreign types.
+"""
+    $(SIGNATURES)
+"""
+getUserId(dfg::AbstractDFG) = dfg.userId
 
-Example:
+"""
+    $(SIGNATURES)
+"""
+getRobotId(dfg::AbstractDFG) = dfg.robotId
 
-Template to tunnel types from a user module:
-```julia
-# or more generic solution -- will always try Main if available
-IIF.setSerializationNamespace!(Main)
+"""
+    $(SIGNATURES)
+"""
+getSessionId(dfg::AbstractDFG) = dfg.sessionId
 
-# or a specific package such as RoME if you import all variable and factor types into a specific module.
-using RoME
-IIF.setSerializationNamespace!(RoME)
-```
 """
-function setSerializationModule!(dfg::G, mod::Module)::Nothing where G <: AbstractDFG
-    @warn "Setting serialization module from AbstractDFG - override this in the '$(typeof(dfg)) structure! This is being ignored."
-end
+    $(SIGNATURES)
+"""
+getAddHistory(dfg::AbstractDFG) = dfg.addHistory
 
-function getSerializationModule(dfg::G)::Module where G <: AbstractDFG
-    @warn "Retrieving serialization module from AbstractDFG - override this in the '$(typeof(dfg)) structure! This is returning Main"
-    return Main
-end
+"""
+    $(SIGNATURES)
+"""
+getSolverParams(dfg::AbstractDFG) = dfg.solverParams
 
-# Accessors
-function getLabelDict(dfg::G) where G <: AbstractDFG
-    error("getLabelDict not implemented for $(typeof(dfg))")
-end
-function getDescription(dfg::G) where G <: AbstractDFG
-    error("getDescription not implemented for $(typeof(dfg))")
-end
-function setDescription(dfg::G, description::String) where G <: AbstractDFG
-    error("setDescription not implemented for $(typeof(dfg))")
-end
-function getAddHistory(dfg::G) where G <: AbstractDFG
-    error("getAddHistory not implemented for $(typeof(dfg))")
-end
-function getSolverParams(dfg::G) where G <: AbstractDFG
-    error("getSolverParams not implemented for $(typeof(dfg))")
-end
-function setSolverParams(dfg::G, solverParams::T) where {G <: AbstractDFG, T <: AbstractParams}
-    error("setSolverParams not implemented for $(typeof(dfg))")
-end
+
+# Setters
+"""
+    $(SIGNATURES)
+"""
+setDescription!(dfg::AbstractDFG, description::String) = dfg.description = description
 
+"""
+    $(SIGNATURES)
+"""
+setUserId!(dfg::AbstractDFG, userId::String) = dfg.userId = userId
+
+"""
+    $(SIGNATURES)
+"""
+setRobotId!(dfg::AbstractDFG, robotId::String) = dfg.robotId = robotId
+
+"""
+    $(SIGNATURES)
+"""
+setSessionId!(dfg::AbstractDFG, sessionId::String) = dfg.sessionId = sessionId
+
+"""
+    $(SIGNATURES)
+"""
+#TODO don't know what error will be thrown if solverParams type does not mach the one in dfg
+setSolverParams!(dfg::AbstractDFG, solverParams::AbstractParams) = dfg.solverParams = solverParams
+
+# Accessors and CRUD for user/robot/session Data
 """
 $SIGNATURES
 
 Get the user data associated with the graph.
 """
 getUserData(dfg::AbstractDFG)::Union{Nothing, Dict{Symbol, String}} = return dfg.userData
+
 """
 $SIGNATURES
 
@@ -63,12 +93,14 @@ function setUserData!(dfg::AbstractDFG, data::Dict{Symbol, String})::Union{Nothi
     dfg.userData = data
     return dfg.userData
 end
+
 """
 $SIGNATURES
 
 Get the robot data associated with the graph.
 """
 getRobotData(dfg::AbstractDFG)::Union{Nothing, Dict{Symbol, String}} = return dfg.robotData
+
 """
 $SIGNATURES
 
@@ -78,12 +110,14 @@ function setRobotData!(dfg::AbstractDFG, data::Dict{Symbol, String})::Union{Noth
     dfg.robotData = data
     return dfg.robotData
 end
+
 """
 $SIGNATURES
 
 Get the session data associated with the graph.
 """
 getSessionData(dfg::AbstractDFG)::Dict{Symbol, String} = return dfg.sessionData
+
 """
 $SIGNATURES
 
@@ -112,6 +146,38 @@ emptyUserData!(dfg::AbstractDFG) = empty!(dfg.userData)
 emptyRobotData!(dfg::AbstractDFG) = empty!(dfg.userData)
 emptySessionData!(dfg::AbstractDFG) = empty!(dfg.userData)
 
+
+
+
+##
+"""
+    $(SIGNATURES)
+
+Deserialization of IncrementalInference objects require discovery of foreign types.
+
+Example:
+
+Template to tunnel types from a user module:
+```julia
+# or more generic solution -- will always try Main if available
+IIF.setSerializationNamespace!(Main)
+
+# or a specific package such as RoME if you import all variable and factor types into a specific module.
+using RoME
+IIF.setSerializationNamespace!(RoME)
+```
+"""
+function setSerializationModule!(dfg::G, mod::Module)::Nothing where G <: AbstractDFG
+    @warn "Setting serialization module from AbstractDFG - override this in the '$(typeof(dfg)) structure! This is being ignored."
+end
+
+function getSerializationModule(dfg::G)::Module where G <: AbstractDFG
+    @warn "Retrieving serialization module from AbstractDFG - override this in the '$(typeof(dfg)) structure! This is returning Main"
+    return Main
+end
+
+
+
 """
     $(SIGNATURES)
 True if the variable or factor exists in the graph.
@@ -777,6 +843,7 @@ function getBiadjacencyMatrix(dfg::AbstractDFG; solvable::Int=0)::NamedTuple{(:B
 end
 
 function getAdjacencyMatrixSparse(dfg::AbstractDFG; solvable::Int=0)
+    @warn "Deprecated function, please use getBiadjacencyMatrix as this will be removed in v0.6.1"
     return getBiadjacencyMatrix(dfg, solvable)
 end
 # -------------------------

test/LightDFGSummaryTypes.jl

@@ -63,7 +63,7 @@ end
     # Accessors
     @test getAddHistory(dfg) == [:a, :b] #, :f1
     @test getDescription(dfg) != nothing
-    @test getLabelDict(dfg) != nothing
+    @test_throws ErrorException getLabelDict(dfg)
     # Existence
     @test exists(dfg, :a) == true
     @test exists(dfg, v1) == true

test/iifInterfaceTests.jl

@@ -110,7 +110,8 @@ end
     # Accessors
     @test getAddHistory(dfg) == [:a, :b] #, :abf1
     @test getDescription(dfg) != nothing
-    @test getLabelDict(dfg) != nothing
+    #TODO Deprecate
+    @test_throws ErrorException getLabelDict(dfg)
     # Existence
     @test exists(dfg, :a) == true
     @test exists(dfg, v1) == true
@@ -171,7 +172,7 @@ end
     @test internalId(f1) == f1._internalId
 
     @test getSolverParams(dfg) != nothing
-    @test setSolverParams(dfg, getSolverParams(dfg)) == getSolverParams(dfg)
+    @test setSolverParams!(dfg, getSolverParams(dfg)) == getSolverParams(dfg)
 
     #solver data is initialized
     @test !isInitialized(dfg, :a)