AppFwk: Remove obsolete plantuml documentation stuff

This commit is contained in:
Jacob Støren committed 2018-11-27 14:59:30 +01:00
1 parent e6685e139a
commit 7a0fcaa2ec
4 files changed
+31 -349

No files matched your search

+31 -34
View File
@@ -1,6 +1,6 @@
@startuml @startuml
class PdmObject { class PdmObjectHandle {
name() name()
fields(); fields();
referencingFields(); referencingFields();
@@ -14,16 +14,16 @@ class PdmObject {
} }
PdmObject --* "n" PdmObjectCapability PdmObjectHandle --* "n" PdmObjectCapability
class PdmUiItem{ class PdmUiItem{
} }
PdmObjectCapability <|- PdmUiObject PdmObjectCapability <|- PdmUiObjectHandle
PdmUiItem <|- PdmUiObject PdmUiItem <|- PdmUiObjectHandle
class PdmUiObject{ class PdmUiObjectHandle {
uiOrdering() = ?; uiOrdering() = ?;
uiTreeOrdering() = ? ; uiTreeOrdering() = ? ;
editorAttribute() = ?; editorAttribute() = ?;
@@ -41,24 +41,24 @@ class PdmUiObject{
m_objectToggleField; m_objectToggleField;
} }
PdmUiObject <|-- PdmCompleteObject PdmUiObjectHandle <|-- PdmObject
PdmObject <|-- PdmCompleteObject PdmObjectHandle <|-- PdmObject
PdmXmlSerializable <|-- PdmCompleteObject PdmXmlObjectHandle <|-- PdmObject
class PdmXmlSerializable { class PdmXmlObjectHandle {
classKeyword() = 0; classKeyword() = 0;
readFields (); readFields ();
writeFields(); writeFields();
} }
PdmObjectCapability <|- PdmXmlSerializable PdmObjectCapability <|- PdmXmlObjectHandle
package FieldHandle{ package FieldHandle{
PdmObject --> "n" PdmFieldHandle PdmObjectHandle --> "n" PdmFieldHandle
class PdmFieldHandle{ class PdmFieldHandle{
name() name()
@@ -107,56 +107,53 @@ class PdmXmlFieldHandle {
PdmFieldCapability <|- PdmXmlFieldHandle PdmFieldCapability <|- PdmXmlFieldHandle
PdmFieldHandle <|-- PdmCompleteFieldHandle
PdmUiFieldHandle <|-- PdmCompleteFieldHandle
PdmXmlFieldHandle <|-- PdmCompleteFieldHandle
} }
package ToDoFields{ package ToDoFields{
class "PdmFieldXmlCap<PdmPtrField<T>>"{ class "InternalPdmXmlFieldCapability<PdmPtrField<T>>"{
} }
} }
package SplittedFields{ package SplittedFields{
PdmFieldHandle <|--- "PdmField<T>" PdmFieldHandle <|--- "PdmField<T>"
"PdmField<T>" --> "PdmFieldUiCap<FieldT>" "PdmField<T>" --> "InternalPdmUiFieldCapability<FieldT>"
"PdmField<T>" --> "PdmFieldXmlCap<FieldT>" "PdmField<T>" --> "InternalPdmXmlFieldCapability<FieldT>"
PdmFieldHandle <|--- "PdmProxyField<T>" PdmFieldHandle <|--- "PdmProxyField<T>"
"PdmProxyField<T>" --> "PdmFieldUiCap<FieldT>" "PdmProxyField<T>" --> "InternalPdmUiFieldCapability<FieldT>"
"PdmProxyField<T>" --> "PdmFieldXmlCap<FieldT>" "PdmProxyField<T>" --> "InternalPdmXmlFieldCapability<FieldT>"
PdmUiFieldHandle <|--- "PdmFieldUiCap<FieldT>" PdmUiFieldHandle <|--- "InternalPdmUiFieldCapability<FieldT>"
PdmXmlFieldHandle <|--- "PdmFieldXmlCap<FieldT>" PdmXmlFieldHandle <|--- "InternalPdmXmlFieldCapability<FieldT>"
PdmFieldHandle <|--- "PdmPtrField<T*>" PdmFieldHandle <|--- "PdmPtrField<T*>"
"PdmPtrField<T*>" --> "PdmFieldUiCap<FieldT>" "PdmPtrField<T*>" --> "InternalPdmUiFieldCapability<FieldT>"
"PdmPtrField<T*>" --> "PdmFieldXmlCap<FieldT>" "PdmPtrField<T*>" --> "InternalPdmXmlFieldCapability<FieldT>"
"PdmPtrField<T*>" ..> "Todo" "PdmFieldXmlCap<PdmPtrField<T>>" "PdmPtrField<T*>" ..> "Todo" "InternalPdmXmlFieldCapability<PdmPtrField<T>>"
PdmFieldHandle <|--- "PdmChildField<T*>" PdmFieldHandle <|--- "PdmChildField<T*>"
"PdmChildField<T*>"--> "PdmFieldUiCap<PdmField<T*>>" "PdmChildField<T*>"--> "InternalPdmUiFieldCapability<PdmField<T*>>"
"PdmChildField<T*>"--> "PdmFieldXmlCap<PdmField<T*>>" "PdmChildField<T*>"--> "InternalPdmXmlFieldCapability<PdmField<T*>>"
PdmFieldHandle <|--- "PdmChildArrayField<T*>" PdmFieldHandle <|--- "PdmChildArrayField<T*>"
"PdmChildArrayField<T*>"--> "PdmFieldUiCap<PdmPointersField<T*>>" "PdmChildArrayField<T*>"--> "InternalPdmUiFieldCapability<PdmPointersField<T*>>"
"PdmChildArrayField<T*>"--> "PdmFieldXmlCap<PdmPointersField<T*>>" "PdmChildArrayField<T*>"--> "InternalPdmXmlFieldCapability<PdmPointersField<T*>>"
} }
package ToDoFields{ package ToDoFields{
PdmFieldHandle <|-- "PdmProxyPtrField<T>" PdmFieldHandle <|-- "PdmProxyPtrField<T>"
"PdmProxyPtrField<T>" --> "PdmFieldUiCap<FieldT>" "PdmProxyPtrField<T>" --> "InternalPdmUiFieldCapability<FieldT>"
"PdmProxyPtrField<T>" ..> "Todo" "PdmFieldXmlCap<PdmPtrField<T>>" "PdmProxyPtrField<T>" ..> "Todo" "InternalPdmXmlFieldCapability<PdmPtrField<T>>"
PdmFieldHandle <|-- "PdmProxyChildField<T*>" PdmFieldHandle <|-- "PdmProxyChildField<T*>"
"PdmProxyChildField<T*>"--> "PdmFieldUiCap<PdmField<T*>>" "PdmProxyChildField<T*>"--> "InternalPdmUiFieldCapability<PdmField<T*>>"
"PdmProxyChildField<T*>"--> "PdmFieldXmlCap<PdmField<T*>>" "PdmProxyChildField<T*>"--> "InternalPdmXmlFieldCapability<PdmField<T*>>"
PdmFieldHandle <|-- "PdmProxyChildArrayField<T*>" PdmFieldHandle <|-- "PdmProxyChildArrayField<T*>"
"PdmProxyChildArrayField<T*>"--> "PdmFieldUiCap<PdmPointersField<T*>>" "PdmProxyChildArrayField<T*>"--> "InternalPdmUiFieldCapability<PdmPointersField<T*>>"
"PdmProxyChildArrayField<T*>"--> "PdmFieldXmlCap<PdmPointersField<T*>>" "PdmProxyChildArrayField<T*>"--> "InternalPdmXmlFieldCapability<PdmPointersField<T*>>"
} }
@@ -1,163 +0,0 @@
@startuml
class PdmObjectHandle {
name()
fields();
referencingFields();
parentField();
template<T> capability()
void addCapability()
---
std::vector<PdmFieldHandle> m_fields;
std::vector<PdmObjectCapability*> 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<PdmFieldCapability*> 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<PdmPtrField<T>>"{
}
}
package SplittedFields{
PdmFieldHandle <|--- "PdmField<T>"
"PdmField<T>" --> "InternalPdmUiFieldCapability<FieldT>"
"PdmField<T>" --> "InternalPdmXmlFieldCapability<FieldT>"
PdmFieldHandle <|--- "PdmProxyField<T>"
"PdmProxyField<T>" --> "InternalPdmUiFieldCapability<FieldT>"
"PdmProxyField<T>" --> "InternalPdmXmlFieldCapability<FieldT>"
PdmUiFieldHandle <|--- "InternalPdmUiFieldCapability<FieldT>"
PdmXmlFieldHandle <|--- "InternalPdmXmlFieldCapability<FieldT>"
PdmFieldHandle <|--- "PdmPtrField<T*>"
"PdmPtrField<T*>" --> "InternalPdmUiFieldCapability<FieldT>"
"PdmPtrField<T*>" --> "InternalPdmXmlFieldCapability<FieldT>"
"PdmPtrField<T*>" ..> "Todo" "InternalPdmXmlFieldCapability<PdmPtrField<T>>"
PdmFieldHandle <|--- "PdmChildField<T*>"
"PdmChildField<T*>"--> "InternalPdmUiFieldCapability<PdmField<T*>>"
"PdmChildField<T*>"--> "InternalPdmXmlFieldCapability<PdmField<T*>>"
PdmFieldHandle <|--- "PdmChildArrayField<T*>"
"PdmChildArrayField<T*>"--> "InternalPdmUiFieldCapability<PdmPointersField<T*>>"
"PdmChildArrayField<T*>"--> "InternalPdmXmlFieldCapability<PdmPointersField<T*>>"
}
package ToDoFields{
PdmFieldHandle <|-- "PdmProxyPtrField<T>"
"PdmProxyPtrField<T>" --> "InternalPdmUiFieldCapability<FieldT>"
"PdmProxyPtrField<T>" ..> "Todo" "InternalPdmXmlFieldCapability<PdmPtrField<T>>"
PdmFieldHandle <|-- "PdmProxyChildField<T*>"
"PdmProxyChildField<T*>"--> "InternalPdmUiFieldCapability<PdmField<T*>>"
"PdmProxyChildField<T*>"--> "InternalPdmXmlFieldCapability<PdmField<T*>>"
PdmFieldHandle <|-- "PdmProxyChildArrayField<T*>"
"PdmProxyChildArrayField<T*>"--> "InternalPdmUiFieldCapability<PdmPointersField<T*>>"
"PdmProxyChildArrayField<T*>"--> "InternalPdmXmlFieldCapability<PdmPointersField<T*>>"
}
@enduml
@@ -1,17 +0,0 @@
@startuml
title Simplified Overview of Pdm classes
PdmUiItem <|---- PdmUiObjectHandle
PdmUiObjectHandle <|-- PdmObject
PdmObject <|-- YourClass
PdmUiItem <|-- PdmUiFieldHandle
PdmFieldHandle -* PdmUiFieldHandle
PdmFieldHandle <|--- "PdmField<T>"
PdmFieldHandle <|--- "PdmProxyField<T>"
PdmFieldHandle <|--- "PdmPtrField<T*>"
PdmFieldHandle <|--- "PdmChildField<T*>"
PdmFieldHandle <|--- "PdmChildArrayField<T*>"
@enduml
@@ -1,135 +0,0 @@
@startuml
class PdmObjectHandle {
name()
fields();
referencingFields();
parentField();
template<T> capability()
void addCapability()
---
std::vector<PdmFieldHandle> m_fields;
std::vector<PdmObjectCapability*> 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<PdmFieldCapability*> 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<T*>"
PdmFieldHandle <|- "PdmChildField<T*>"
PdmFieldHandle <|- PdmValueField
PdmValueField <|-- "PdmDataValueField<T>"
PdmValueField <|-- "PdmProxyValueField<T>"
PdmFieldHandle <|- PdmChildArrayFieldHandle
PdmChildArrayFieldHandle <|-- "PdmChildArrayField<T*>"
PdmField ..u.. PdmValueField
class PdmField {
Macro used to replace
PdmField with PdmValueField (used in ResInsight)
}
@enduml