Naming convention:
- Path preamble: org.onf.cim.core, org.onf.tsim, org.onf.iisomi
- Path field: lowerCamelCase; for example: org.onf.cim.core.network.forwardingDomain
- Module name: lowerCamelCase; for example: org.onf.cim.core.processingConstruct
- Folder (Papyrus Package) name: lowerCamelCase; for example: org.onf.cim.core.specification.forwardingConstruct
- Module artifact name: follow the modeling guidelines; for examples ObjectClass1, attributeOfObjectClass1, attributeOfObjectClass2
Note that there will be module dependency (acyclic graph), but not module hierarchy.
Module and Path Definitions
NOTE: The following table is still under construction and review!
| Document Nr | Document Title | Module(s) (.di , .notation, .uml) | Path(s) |
|---|---|---|---|
| TR-512 | Core Information Model | - | |
| TR-512.1 | Overview (including module dependencies) | diagrams (for diagrams that cross modules only) Note that the diagram module will be made dependent on every other module | org.onf.cim.diagrams |
| TR-512.2 | Forwarding and Termination | network | org.onf.cim.core.network org.onf.cim.core.network.ltp org.onf.cim.core.network.fc org.onf.cim.core.spec.network.ltp org.onf.cim.core.spec.network.fc org.onf.cim.core.timing.clock |
| TR-512.3 | Foundation | foundation | gen.inject (for generator injection only, this path won't appear for any generated content) (move states datatypes to iisomi common data, and clean up the IISOMI paths at the same time) |
| TR-512.4 | Topology | network | org.onf.cim.core.network.topology org.onf.cim.core.network.topology.fd org.onf.cim.core.network.topology.link |
| TR-512.5 | Resilience | resilience | org.onf.cim.core.network.resilience org.onf.cim.core.network.resilience.casc |
| TR-512.6 | Physical | physical | org.onf.cim.core.physical.equipment org.onf.cim.core.spec.physical.equipment org.onf.cim.core.physical.conStrand |
| TR-512.7 | Specification | specification (patterns and framework) | org.onf.cim.core.specification |
| TR-512.8 | Control | control | org.onf.cim.core.control.controlConstruct org.onf.cim.core.control.exposureContext org.onf.cim.core.control.viewMappingFunction org.onf.cim.core.spec.control.controlConstruct |
| TR-512.9 | OAM (not available yet) | ||
| TR-512.10 | Interaction (previously Interaction Pattern) | interaction | org.onf.cim.core.interaction |
| TR-512.11 | Processing Construct | processingConstruct | org.onf.cim.core.processingConstruct org.onf.cim.core.spec.processingConstruct |
| constraintDomain | org.onf.cim.core.constraintDomain org.onf.cim.core.spec.constraintDomain | ||
| TR-512.12 | Software | software | org.onf.cim.core.software org.onf.cim.core.software.process org.onf.cim.core.software.inventory org.onf.cim.core.software.vm org.onf.cim.core.software.container org.onf.cim.core.fileSystem |
| TR-512.13 | Party | party partyXtn | org.onf.cim.core.party org.onf.cim.core.party.role org.onf.cim.core.party.contact org.onf.cim.core.spec.party |
| TR-512.14 | Location | location locationXtn | org.onf.cim.core.location org.onf.cim.core.location.address org.onf.cim.core.location.geometry org.onf.cim.core.spec.location |
| TR-512.15 | Storage | compute | org.onf.cim.core.storage |
| TR-512.16 | CPU and Memory | compute | org.onf.cim.core.computePool org.onf.cim.core.cpu org.onf.cim.core.memory |
| ? | Job/task | ? | org.onf.cim.core.? |
| TR-512.A.1 | Appendix - Overview | - | - |
| TR-512.A.2 | Appendix - Model Structure Patterns | - | - |
| TR-512.A.3 | Appendix - Model Rationale (including module dependencies) | - | - |
| TR-512.A.4 | Appendix - Analogue and Media Examples | - | org.onf.tsim.photonicMedia.amplifier org.onf.tsim.photonicMedia.transponder |
| TR-512.A.5 | Appendix - Circuit Switch Examples | - | org.onf.tsim.otn org.onf.tsim.otn.???? |
| TR-512.A.6 | Appendix - Packet Switch Examples | - | org.onf.tsim.ethernet org.onf.tsim.mplsTp |
| TR-512.A.7 | Appendix - Control and Interaction Examples | - | - |
| TR-512.A.8 | Appendix - Timing and Synchronization Examples | - | org.onf.tsim.timing.clock |
| TR-512.A.9 | Appendix - Processing Construct Examples | - | - |
| TR-512.A.10 | Appendix - Specification Examples | - | - |
| TR-512.A.11 | Appendix - Resilience Examples | - | - |
| TR-512.A.12 | Appendix - Application (L4 and Above) Examples | - | - |
| TR-512.A.13 | Appendix - Software Examples | - | - |
| TR-512.A.14 | Appendix - Storage Examples | - | - |
| TR-512.P.1 | Presentation - Overview | - | - |
| TR-512.P.2 | Presentation - CIM Introduction | - | - |
| TR-512.P.3 | Presentation - Specification Pattern for new comer | - | - |
| TR-512.W.1 | White Paper - Overview | - | - |
| TR-512.W.2 | White Paper - Backward compatibility | - | - |
| TR-512.DD | Data Dictionary | - | - |
| TR-512.TM | Terminology Mapping | - | - |
| TR-512.FE | Future Enhancement | - | - |
| - | Open Model Profile | openModelProfile | org.onf.iisomi.openModelProfile |
| - | Open Interface Model Profile | openInterfaceModelProfile | org.onf.iisomi.openInterfaceModelProfile |
| - | Profile Lifecycle Profile | profileLifecycleProfile | org.onf.iisomi.profileLifecycleProfile |
| - | Common Datatype | commonDatatype | org.onf.iisomi.commonDatatype org.onf.iisomi.commonDatatype.state |
Module Dependency Graph
The module dependencies are always one-way and they must form an acyclic graph (no loops).
All relationships between modules (inheritance, associations, datatype references) must be in the same direction as the dependency arrows.
(Draft rough diagram shown below, will be replaced by the papyrus diagram)
Overview
Content Tools
Activity
1 Comment
Chris Hartley
Use .core for core model only.
Use .tsim for technology specific information model