From ea3bbd1cf96def5f6023b0a386fdc93ce5e021dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Jensen?= Date: Wed, 11 Apr 2018 08:20:22 +0200 Subject: [PATCH] #2610 UML diagrams --- doc/case_collections.plantuml | 57 +++++++++++++++++++++++++++++++++++ doc/curve_creator.plantuml | 54 +++++++++++++++++++++++++++++++++ doc/legends.plantuml | 21 +++++++++++++ 3 files changed, 132 insertions(+) create mode 100644 doc/case_collections.plantuml create mode 100644 doc/curve_creator.plantuml create mode 100644 doc/legends.plantuml diff --git a/doc/case_collections.plantuml b/doc/case_collections.plantuml new file mode 100644 index 0000000000..bfebd6b19f --- /dev/null +++ b/doc/case_collections.plantuml @@ -0,0 +1,57 @@ +@startuml + +package "Summary case ensamble" { + + skinparam class { + BackgroundColor<> LightGray + } + + package Cases { + RimSummaryCaseMainCollection --> "*" RimSummaryCaseCollection + RimSummaryCaseMainCollection --> "*" RimSummaryCase + RimSummaryCaseCollection --> "*" RimSummaryCase + + RimSummaryCase -> RigCaseRealizationParameters + + 'RimSummaryCaseMainCollection ..> RifEnsambleParametersReader + RimSummaryCaseMainCollection ..> RifCaseRealizationParametersReader : create + RifCaseRealizationParametersReader ..> RimSummaryCase : set parameters + + class RifSummaryReaderInterface { + allResultAddresses() + } + class RimEnsambleSummaryCase << New >> + class RifReaderEnsambleSummary << New >> + RimSummaryCase <|-- RimGridSummaryCase + RimSummaryCase <|-- RimEnsambleSummaryCase + RimSummaryCase --> RifSummaryReaderInterface + RifSummaryReaderInterface <|-- RifReaderEclipseSummary + RifSummaryReaderInterface <|-- RifReaderEnsambleSummary + RimEnsambleSummaryCase ..> RifReaderEnsambleSummary + RimEnsambleSummaryCase --> RimSummaryCaseCollection + RimGridSummaryCase ..> RifReaderEclipseSummary + } + + package Curves { + RimMainPlotCollection --> RimSummaryPlotCollection + RimSummaryPlotCollection --> "*" RimSummaryPlot + + RimSummaryPlot --> RimSummaryCurveCollection + RimSummaryPlot -> RimEnsambleCurveSetCollection + RimSummaryCurveCollection --> "*" RimSummaryCurve + RimSummaryCurveCollection -> "3" RimSummaryPlotSourceStepping + RimEnsambleCurveSetCollection --> RimEnsambleCurveSet + RimEnsambleCurveSet --> "*" RimSummaryCurve + } + + RimProject -> RimMainPlotCollection + RimProject --> "*" RimOilField + RimOilField --> RimSummaryCaseMainCollection + + RimSummaryCurve -> RimSummaryCase + RimSummaryCurve --> RifEclipseSummaryAddress + + RifSummaryReaderInterface --> "*" RifEclipseSummaryAddress +} + +@enduml diff --git a/doc/curve_creator.plantuml b/doc/curve_creator.plantuml new file mode 100644 index 0000000000..1727120710 --- /dev/null +++ b/doc/curve_creator.plantuml @@ -0,0 +1,54 @@ +@startuml + +package "Curve creator (Plot editor)" { + +' +' Class definitions +' +class RicSummaryCurveCreatorSplitterUi { + Qt layouts +} + +class RicSummaryCurveCreator { + Appearance types + OK/Apply/Cancel buttons +} + +class RiuSummaryCurveDefSelectionEditor { + m_firstRowLeftLayout + m_firstRowRightLayout +} + +class RiuSummaryCurveDefSelection { + Cases + Summary categories + Identifier fields +} + +' +' Class Hierarchy +' +PdmUiWidgetBasedObjectEditor <|- RicSummaryCurveCreatorSplitterUi +PdmUiWidgetBasedObjectEditor <|- RicSummaryCurveCreatorTabsUi +PdmUiWidgetBasedObjectEditor <|-- RiuSummaryCurveDefSelectionEditor + +' +' Class references +' +RicSummaryCurveCreatorDialog --> RicSummaryCurveCreatorTabsUi + +RicSummaryCurveCreatorSplitterUi ->RicSummaryCurveCreator + +RicSummaryCurveCreatorTabsUi -> RicSummaryCurveCreatorSplitterUi : curves +RicSummaryCurveCreatorTabsUi -> RicSummaryCurveCreatorSplitterUi : ensambles + +RicSummaryCurveCreator --> RiuSummaryCurveDefSelectionEditor + +RicSummaryCurveCreator --> RimSummaryPlot : Target plot +RicSummaryCurveCreator --> RimSummaryPlot : Preview plot + +RiuSummaryCurveDefSelectionEditor --> RiuSummaryCurveDefSelection + +} + +@enduml diff --git a/doc/legends.plantuml b/doc/legends.plantuml new file mode 100644 index 0000000000..8ca560617b --- /dev/null +++ b/doc/legends.plantuml @@ -0,0 +1,21 @@ +@startuml + +package Legends { + + OverlayItem <|-- OverlayScalarMapperLegend + + ScalarMapper <|-- ScalarMapperRangeBased + ScalarMapperRangeBased <|-- ScalarMapperContinuousLinear + ScalarMapperRangeBased <|-- ScalarMapperDiscreteLinear + + RimStimPlanColors --> RimLegendConfig + Rim2dIntersectionView --> RimLegendConfig + RimEclipseCellColors --> RimLegendConfig + + RimLegendConfig --> ScalarMapper + RimLegendConfig --> OverlayScalarMapperLegend + + OverlayScalarMapperLegend --> ScalarMapper +} + +@enduml