From 7a0fcaa2ec125be9490eca292dbc4f32faa2d54d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacob=20St=C3=B8ren?= Date: Tue, 27 Nov 2018 12:35:02 +0100 Subject: [PATCH] AppFwk: Remove obsolete plantuml documentation stuff --- .../cafProjectDataModel/PdmCore.plantuml | 65 ++++--- .../PdmCoreNewNames.plantuml | 163 ------------------ .../PdmCoreUserOverviewCondensed.plantuml | 17 -- .../PdmModularization.plantuml | 135 --------------- 4 files changed, 31 insertions(+), 349 deletions(-) delete mode 100644 Fwk/AppFwk/cafProjectDataModel/PdmCoreNewNames.plantuml delete mode 100644 Fwk/AppFwk/cafProjectDataModel/PdmCoreUserOverviewCondensed.plantuml delete mode 100644 Fwk/AppFwk/cafProjectDataModel/PdmModularization.plantuml diff --git a/Fwk/AppFwk/cafProjectDataModel/PdmCore.plantuml b/Fwk/AppFwk/cafProjectDataModel/PdmCore.plantuml index 2cf0221beb..aef25defb0 100644 --- a/Fwk/AppFwk/cafProjectDataModel/PdmCore.plantuml +++ b/Fwk/AppFwk/cafProjectDataModel/PdmCore.plantuml @@ -1,6 +1,6 @@ @startuml -class PdmObject { +class PdmObjectHandle { name() fields(); referencingFields(); @@ -14,16 +14,16 @@ class PdmObject { } -PdmObject --* "n" PdmObjectCapability +PdmObjectHandle --* "n" PdmObjectCapability class PdmUiItem{ } -PdmObjectCapability <|- PdmUiObject -PdmUiItem <|- PdmUiObject +PdmObjectCapability <|- PdmUiObjectHandle +PdmUiItem <|- PdmUiObjectHandle -class PdmUiObject{ +class PdmUiObjectHandle { uiOrdering() = ?; uiTreeOrdering() = ? ; editorAttribute() = ?; @@ -41,24 +41,24 @@ class PdmUiObject{ m_objectToggleField; } -PdmUiObject <|-- PdmCompleteObject -PdmObject <|-- PdmCompleteObject -PdmXmlSerializable <|-- PdmCompleteObject +PdmUiObjectHandle <|-- PdmObject +PdmObjectHandle <|-- PdmObject +PdmXmlObjectHandle <|-- PdmObject -class PdmXmlSerializable { +class PdmXmlObjectHandle { classKeyword() = 0; readFields (); writeFields(); } -PdmObjectCapability <|- PdmXmlSerializable +PdmObjectCapability <|- PdmXmlObjectHandle package FieldHandle{ -PdmObject --> "n" PdmFieldHandle +PdmObjectHandle --> "n" PdmFieldHandle class PdmFieldHandle{ name() @@ -107,56 +107,53 @@ class PdmXmlFieldHandle { PdmFieldCapability <|- PdmXmlFieldHandle -PdmFieldHandle <|-- PdmCompleteFieldHandle -PdmUiFieldHandle <|-- PdmCompleteFieldHandle -PdmXmlFieldHandle <|-- PdmCompleteFieldHandle } package ToDoFields{ -class "PdmFieldXmlCap>"{ +class "InternalPdmXmlFieldCapability>"{ } } package SplittedFields{ PdmFieldHandle <|--- "PdmField" -"PdmField" --> "PdmFieldUiCap" -"PdmField" --> "PdmFieldXmlCap" +"PdmField" --> "InternalPdmUiFieldCapability" +"PdmField" --> "InternalPdmXmlFieldCapability" PdmFieldHandle <|--- "PdmProxyField" -"PdmProxyField" --> "PdmFieldUiCap" -"PdmProxyField" --> "PdmFieldXmlCap" +"PdmProxyField" --> "InternalPdmUiFieldCapability" +"PdmProxyField" --> "InternalPdmXmlFieldCapability" -PdmUiFieldHandle <|--- "PdmFieldUiCap" -PdmXmlFieldHandle <|--- "PdmFieldXmlCap" +PdmUiFieldHandle <|--- "InternalPdmUiFieldCapability" +PdmXmlFieldHandle <|--- "InternalPdmXmlFieldCapability" PdmFieldHandle <|--- "PdmPtrField" -"PdmPtrField" --> "PdmFieldUiCap" -"PdmPtrField" --> "PdmFieldXmlCap" -"PdmPtrField" ..> "Todo" "PdmFieldXmlCap>" +"PdmPtrField" --> "InternalPdmUiFieldCapability" +"PdmPtrField" --> "InternalPdmXmlFieldCapability" +"PdmPtrField" ..> "Todo" "InternalPdmXmlFieldCapability>" PdmFieldHandle <|--- "PdmChildField" -"PdmChildField"--> "PdmFieldUiCap>" -"PdmChildField"--> "PdmFieldXmlCap>" +"PdmChildField"--> "InternalPdmUiFieldCapability>" +"PdmChildField"--> "InternalPdmXmlFieldCapability>" PdmFieldHandle <|--- "PdmChildArrayField" -"PdmChildArrayField"--> "PdmFieldUiCap>" -"PdmChildArrayField"--> "PdmFieldXmlCap>" +"PdmChildArrayField"--> "InternalPdmUiFieldCapability>" +"PdmChildArrayField"--> "InternalPdmXmlFieldCapability>" } package ToDoFields{ PdmFieldHandle <|-- "PdmProxyPtrField" -"PdmProxyPtrField" --> "PdmFieldUiCap" -"PdmProxyPtrField" ..> "Todo" "PdmFieldXmlCap>" +"PdmProxyPtrField" --> "InternalPdmUiFieldCapability" +"PdmProxyPtrField" ..> "Todo" "InternalPdmXmlFieldCapability>" PdmFieldHandle <|-- "PdmProxyChildField" -"PdmProxyChildField"--> "PdmFieldUiCap>" -"PdmProxyChildField"--> "PdmFieldXmlCap>" +"PdmProxyChildField"--> "InternalPdmUiFieldCapability>" +"PdmProxyChildField"--> "InternalPdmXmlFieldCapability>" PdmFieldHandle <|-- "PdmProxyChildArrayField" -"PdmProxyChildArrayField"--> "PdmFieldUiCap>" -"PdmProxyChildArrayField"--> "PdmFieldXmlCap>" +"PdmProxyChildArrayField"--> "InternalPdmUiFieldCapability>" +"PdmProxyChildArrayField"--> "InternalPdmXmlFieldCapability>" } diff --git a/Fwk/AppFwk/cafProjectDataModel/PdmCoreNewNames.plantuml b/Fwk/AppFwk/cafProjectDataModel/PdmCoreNewNames.plantuml deleted file mode 100644 index aef25defb0..0000000000 --- a/Fwk/AppFwk/cafProjectDataModel/PdmCoreNewNames.plantuml +++ /dev/null @@ -1,163 +0,0 @@ -@startuml - -class PdmObjectHandle { - name() - fields(); - referencingFields(); - parentField(); - template capability() - void addCapability() - ---- - std::vector m_fields; - std::vector m_capabilities; -} - - -PdmObjectHandle --* "n" PdmObjectCapability - -class PdmUiItem{ - -} - -PdmObjectCapability <|- PdmUiObjectHandle -PdmUiItem <|- PdmUiObjectHandle - -class PdmUiObjectHandle { - uiOrdering() = ?; - uiTreeOrdering() = ? ; - editorAttribute() = ?; - - objectEditorAttribute() = ? ; - - userDescriptionField(); - objectToggleField() - - calculateValueOptions() = ?; - - fieldChangedByUi() = 0; - --- - m_descriptionField; - m_objectToggleField; -} - -PdmUiObjectHandle <|-- PdmObject -PdmObjectHandle <|-- PdmObject -PdmXmlObjectHandle <|-- PdmObject - - -class PdmXmlObjectHandle { - classKeyword() = 0; - readFields (); - writeFields(); -} - -PdmObjectCapability <|- PdmXmlObjectHandle - - - -package FieldHandle{ - -PdmObjectHandle --> "n" PdmFieldHandle - -class PdmFieldHandle{ - name() - - setOwnerObject(); - ownerObject(); - - hasChildObjects() = 0; - childObjects( ) = 0; - --- - std::vector m_attributes; -} - - -PdmFieldHandle --* "n" PdmFieldCapability - -class PdmUiFieldHandle{ - - uiValue() - setValueFromUi() - - valueOptions( ) = 0; - -} - -PdmFieldCapability <|- PdmUiFieldHandle -PdmUiItem <|- PdmUiFieldHandle - - -class PdmXmlFieldHandle { - setKeyword(); - keyword(); - - readFieldData() = 0; - writeFieldData() = 0; - - isIOReadable() - isIOWritable() - setIOWritable() - setIOReadable() ---- - bool m_isReadable; - bool m_isWritable; -} - -PdmFieldCapability <|- PdmXmlFieldHandle - - - -} - -package ToDoFields{ -class "InternalPdmXmlFieldCapability>"{ -} -} - -package SplittedFields{ - -PdmFieldHandle <|--- "PdmField" -"PdmField" --> "InternalPdmUiFieldCapability" -"PdmField" --> "InternalPdmXmlFieldCapability" - -PdmFieldHandle <|--- "PdmProxyField" -"PdmProxyField" --> "InternalPdmUiFieldCapability" -"PdmProxyField" --> "InternalPdmXmlFieldCapability" - -PdmUiFieldHandle <|--- "InternalPdmUiFieldCapability" -PdmXmlFieldHandle <|--- "InternalPdmXmlFieldCapability" - -PdmFieldHandle <|--- "PdmPtrField" -"PdmPtrField" --> "InternalPdmUiFieldCapability" -"PdmPtrField" --> "InternalPdmXmlFieldCapability" -"PdmPtrField" ..> "Todo" "InternalPdmXmlFieldCapability>" - -PdmFieldHandle <|--- "PdmChildField" -"PdmChildField"--> "InternalPdmUiFieldCapability>" -"PdmChildField"--> "InternalPdmXmlFieldCapability>" -PdmFieldHandle <|--- "PdmChildArrayField" -"PdmChildArrayField"--> "InternalPdmUiFieldCapability>" -"PdmChildArrayField"--> "InternalPdmXmlFieldCapability>" - -} - - -package ToDoFields{ -PdmFieldHandle <|-- "PdmProxyPtrField" -"PdmProxyPtrField" --> "InternalPdmUiFieldCapability" -"PdmProxyPtrField" ..> "Todo" "InternalPdmXmlFieldCapability>" - -PdmFieldHandle <|-- "PdmProxyChildField" -"PdmProxyChildField"--> "InternalPdmUiFieldCapability>" -"PdmProxyChildField"--> "InternalPdmXmlFieldCapability>" -PdmFieldHandle <|-- "PdmProxyChildArrayField" -"PdmProxyChildArrayField"--> "InternalPdmUiFieldCapability>" -"PdmProxyChildArrayField"--> "InternalPdmXmlFieldCapability>" - -} - - - -@enduml - \ No newline at end of file diff --git a/Fwk/AppFwk/cafProjectDataModel/PdmCoreUserOverviewCondensed.plantuml b/Fwk/AppFwk/cafProjectDataModel/PdmCoreUserOverviewCondensed.plantuml deleted file mode 100644 index 1c1de6e1a1..0000000000 --- a/Fwk/AppFwk/cafProjectDataModel/PdmCoreUserOverviewCondensed.plantuml +++ /dev/null @@ -1,17 +0,0 @@ -@startuml -title Simplified Overview of Pdm classes - -PdmUiItem <|---- PdmUiObjectHandle -PdmUiObjectHandle <|-- PdmObject -PdmObject <|-- YourClass - -PdmUiItem <|-- PdmUiFieldHandle -PdmFieldHandle -* PdmUiFieldHandle -PdmFieldHandle <|--- "PdmField" -PdmFieldHandle <|--- "PdmProxyField" -PdmFieldHandle <|--- "PdmPtrField" -PdmFieldHandle <|--- "PdmChildField" -PdmFieldHandle <|--- "PdmChildArrayField" - -@enduml - \ No newline at end of file diff --git a/Fwk/AppFwk/cafProjectDataModel/PdmModularization.plantuml b/Fwk/AppFwk/cafProjectDataModel/PdmModularization.plantuml deleted file mode 100644 index af982b8471..0000000000 --- a/Fwk/AppFwk/cafProjectDataModel/PdmModularization.plantuml +++ /dev/null @@ -1,135 +0,0 @@ -@startuml - -class PdmObjectHandle { - name() - fields(); - referencingFields(); - parentField(); - template capability() - void addCapability() - ---- - std::vector m_fields; - std::vector m_capabilities; -} - - -PdmObjectHandle --* "n" PdmObjectCapability - -class PdmUiItem{ - -} - -PdmObjectCapability <|- PdmUiObjectHandle -PdmUiItem <|- PdmUiObjectHandle - -class PdmUiObjectHandle { - uiOrdering() = ?; - uiTreeOrdering() = ? ; - editorAttribute() = ?; - - objectEditorAttribute() = ? ; - - userDescriptionField(); - objectToggleField() - - calculateValueOptions() = ?; - - fieldChangedByUi() = 0; - --- - m_descriptionField; - m_objectToggleField; -} - -PdmUiObjectHandle <|-- PdmObject -PdmObjectHandle <|-- PdmObject -PdmXmlObjectHandle <|-- PdmObject - - -class PdmXmlObjectHandle { - classKeyword() = 0; - readFields (); - writeFields(); -} - -PdmObjectCapability <|- PdmXmlObjectHandle - - - -package FieldHandle{ - -PdmObjectHandle --> "n" PdmFieldHandle - -class PdmFieldHandle{ - name() - - setOwnerObject(); - ownerObject(); - - hasChildObjects() = 0; - childObjects( ) = 0; - --- - std::vector m_attributes; -} - - -PdmFieldHandle --* "n" PdmFieldCapability - -class PdmUiFieldHandle{ - - uiValue() - setValueFromUi() - - valueOptions( ) = 0; - -} - -PdmFieldCapability <|- PdmUiFieldHandle -PdmUiItem <|- PdmUiFieldHandle - - -class PdmXmlFieldHandle { - setKeyword(); - keyword(); - - readFieldData() = 0; - writeFieldData() = 0; - - isIOReadable() - isIOWritable() - setIOWritable() - setIOReadable() ---- - bool m_isReadable; - bool m_isWritable; -} - -PdmFieldCapability <|- PdmXmlFieldHandle - - - -} - - - -PdmFieldHandle <|- "PdmPtrField" -PdmFieldHandle <|- "PdmChildField" - -PdmFieldHandle <|- PdmValueField -PdmValueField <|-- "PdmDataValueField" -PdmValueField <|-- "PdmProxyValueField" - -PdmFieldHandle <|- PdmChildArrayFieldHandle -PdmChildArrayFieldHandle <|-- "PdmChildArrayField" - -PdmField ..u.. PdmValueField - -class PdmField { - Macro used to replace - PdmField with PdmValueField (used in ResInsight) -} - - - -@enduml - \ No newline at end of file