Proposed Location Model
Initial modelling of the information in PNFPlaceModel_202007Jy02.xlsx
... and later version:
Based on work done in the meeting series PNFD/SDC AID/AAI Schema Modeling/5G Svc Model - R7 Discussion
Used in the PNF Plug and Play Use Case: R7 PNF Plug and Play PnP
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
Description:
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
|
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 · reference: RFC4776
|
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
Reference · reference: RFC4776 CAtype=3, 30
|
cityDivision | String | 0..1 | Name of city division, ex. Borough, District, Ward, Chou
| OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY
Reference · reference: RFC4776 CAtype=4
|
cityNeighborhood | String | 0..1 | Name of neighborhood, ex. Block, Street group
| OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY
Reference · reference: RFC4776 CAtype=5, 6
|
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
Reference · reference: ETSI SOL001 tosca.datatypes.nfv.LocationInfo.country_code
|
state | String | 0..1 | The name of the state or province
| OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY
Reference · reference: RFC4776 CAtype=1
|
region | String | 0..1 | The name of the region
| OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY
Reference · reference: RFC4776 CAtype=2
|
postalCode | String | 0..1 | The postal code or zip code
| OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY
Reference · reference: RFC4776 CAtype=24
|
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 | The street address
| OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY
Reference · reference: RFC4776 CAtype=16-23, 25, 34-39
|
lata | String | 0..1 | Local access and transport area (LATA) represents a geographical area of the United States, used in U.S. telecommunications regulation.
| 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
Reference · reference: RFC6225 Datum
|
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
Reference · reference: RFC6225 Latitude
|
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
Reference · reference: RFC6225 LatUnc
|
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
Reference · reference: RFC6225 Longitude
|
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
Reference · reference: RFC6225 LongUnc
|
altitude | String | 0..1 | A 30-bit value defined by the Altitude Type field.
| OpenModelAttribute · isInvariant: false · valueRange: no range constraint · support: MANDATORY
Reference · reference: RFC6225 Altitude
|
altitudeUncertainty | String | 0..1 | When mapDatum = WGS84, this field represents altitude uncertainty.
| OpenModelAttribute |
Comments received at the Resource IM meeting 2020-08-31:
Add a note in the diagram to indicate that at least one of geoCoordinates, civicAddress needs to be specified for each Place instance.
Check if there is a reference for validFor (TMF SID?)
Change altitude and altitudeUnit to optional (to allow two-dimensional place definition)
Rename neighborhood to cityNeighborhood (for consistency)
Add lata to CityQualifiers
Move poBox to StructureQualifiers
Rename placementCode to placementInfo
Add FOOT to AltitudeUnit
Add any missing descriptions based on the original source references