Initial modelling of the information in PNFPlaceModel_202007Jy02.xlsx
Based on work done in the meeting series PNFD/SDC AID/AAI Schema Modeling/5G Svc Model - R7 Discussion
1 Location
1.1 Overview
Qualified Name: Common::Location
1.2 Associations
1.2.1 Overview
Qualified Name: Common::Location::Associations
1.3 Diagrams
1.3.1 Overview
Qualified Name: Common::Location::Diagrams
1.3.1.1 Diagrams
Figure 13‑1: Diagram Place
1.4 ObjectClasses
1.4.1 Overview
Qualified Name: Common::Location::ObjectClasses
1.4.1.1 Classes
1.4.1.1.1 Place class
Qualified Name: Common::Location::ObjectClasses::Place
Parent class: RootEntity
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
- Reference
- reference: From TMF SID
Table 9‑1 Attributes for Package ObjectClasses
Attribute Name | Type | Mult. | Description | Stereotypes |
validFor | TimePeriod | 0..1 | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY | |
physLocationId | String | 1 | Unique identifier for physical location, ex. CLLI (Location ID) | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
physLocationType | String | 1 | Type of physical location, ex. central office, data center, remote site. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
physLocationName | String | 0..1 | Location name | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
geoCoordinates | GeoCoordinates | 0..1 | Geographical coordinates | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Reference · reference: RFC6225 |
civicAddress | CivicAddress | 0..1 | Civic address | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Reference |
name | String | 0..1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
description | String | 0..1 | Defines a textual free-form description of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
1.5 TypeDefinitions
1.5.1 Overview
Qualified Name: Common::Location::TypeDefinitions
1.5.1.1 Datatypes
1.5.1.1.1 CityQualifiers datatype
Qualified Name: Common::Location::TypeDefinitions::CityQualifiers
Table 7‑1 Attributes for Data Type CityQualifiers
Attribute Name | Type | Mult. | Description | Stereotypes |
cityName | String | 1 | Name of City, Township, or Parish | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
cityDivision | String | 0..1 | Name of city division, ex. Borough, District, Ward, Chou | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
neighborhood | String | 0..1 | Name of neighborhood, ex. Block, Street group | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
1.5.1.1.2 CivicAddress datatype
Qualified Name: Common::Location::TypeDefinitions::CivicAddress
Table 7‑1 Attributes for Data Type CivicAddress
Attribute Name | Type | Mult. | Description | Stereotypes |
country | String | 1 | The name of the country | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
state | String | 0..1 | The name of the state or province | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
region | String | 0..1 | The name of the region | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
postalCode | String | 0..1 | The string for the postal code or zip code | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
city | CityQualifiers | 0..1 | The name of the metropolitan area, city, township, borough, district, or ward. Allows further specific city sub-divisions to be specified, such as: division, borough, district, ward, chou, neighborhood, block, street group | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
streetAddress | String | 0..1 | A string describing the street address of the place. | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
poBox | String | 0..1 | Post office box number | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
structureQualifiers | StructureQualifiers | 0..1 | Additional pre-defined qualifier fields for a structure including: unit, floor, room, desk | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
1.5.1.1.3 GeoCoordinates datatype
Qualified Name: Common::Location::TypeDefinitions::GeoCoordinates
Table 7‑1 Attributes for Data Type GeoCoordinates
Attribute Name | Type | Mult. | Description | Stereotypes |
mapDatum | MapDatum | 1 | Map Datum used for the coordinates given in this option. | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
latitude | String | 1 | Latitude in binary geodetic form. A 34-bit fixed-point value consisting of 9 bits of integer and 25 bits of fraction. | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
latitudeUncertainty | String | 0..1 | When mapDatum = WGS84, this field represents latitude uncertainty. Uncertainty = 2 ^ ( 21 - x ). x = 21 - ceil( log2( uncertainty ) ) | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
longitude | String | 1 | Longitude in binary geodetic form. A 34-bit fixed-point value consisting of 9 bits of integer and 25 bits of fraction. | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
longitudeUncertainty | String | 0..1 | When mapDatum = WGS84, this field represents longitude uncertainty. Uncertainty = 2 ^ ( 21 - x ). x = 21 - ceil( log2( uncertainty ) ) | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
altitude | String | 1 | A 30-bit value defined by the Altitude Type field. | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
altitudeUncertainty | String | 0..1 | When mapDatum = WGS84, this field represents altitude uncertainty. | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
altitudeUnit | AltitudeUnit | 1 | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | |
altitudeResolution | String | 0..1 | Encodes the number of high-order altitude bits that should be considered valid. | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
1.5.1.1.4 StructureQualifiers datatype
Qualified Name: Common::Location::TypeDefinitions::StructureQualifiers
Table 7‑1 Attributes for Data Type StructureQualifiers
Attribute Name | Type | Mult. | Description | Stereotypes |
unit | String | 0..1 | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | |
floor | String | 0..1 | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | |
room | String | 0..1 | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | |
desk | String | 0..1 | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY | |
placementCode | String | 0..1 | Additional placement code, ex. Shelf, Rack | OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY |
1.5.1.2 Enumerations
1.5.1.2.1 AltitudeUnit enumeration
Qualified Name: Common::Location::TypeDefinitions::AltitudeUnit
Contains Enumeration Literals:
- METER
- FLOOR
1.5.1.2.2 MapDatum enumeration
Qualified Name: Common::Location::TypeDefinitions::MapDatum
Contains Enumeration Literals:
- WGS84
- NAD83 + NAVD88
- NAD83 + MLLW