1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
|
.. Copyright 2021
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
Location Model
==============
.. contents::
:depth: 3
..
Diagrams
--------
Place
~~~~~
.. image:: Place.png
Classes
-------
Place
~~~~~
**Parent class:** RootEntity
Applied stereotypes:
- Reference
- **reference: From TMF SID**
- Preliminary
- OpenModelClass
- **support: MANDATORY**
================== ============== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== ========================================================
**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in**
validFor TimePeriod 0..1 OpenModelAttribute Common::Location::ObjectClasses::Place::validFor
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Experimental
geoCoordinates GeoCoordinates 0..1 Reference Geographical coordinates Common::Location::ObjectClasses::Place::geoCoordinates
- reference:RFC6225
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
civicAddress CivicAddress 0..1 Reference Civic address Common::Location::ObjectClasses::Place::civicAddress
- reference:RFC4776
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
name String 0..1 Preliminary 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). Common::Root::RootObjectClasses::RootEntity::name
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id
OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object.
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
================== ============== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== ========================================================
RootEntity
~~~~~~~~~~
This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment.
Applied stereotypes:
- Preliminary
- OpenModelClass
- **support: MANDATORY**
================== ========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== ========================================================
**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** **Defined in**
name String 0..1 Preliminary 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). Common::Root::RootObjectClasses::RootEntity::name
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
description String 0..1 Preliminary Defines a textual free-form description of the object. Common::Root::RootObjectClasses::RootEntity::description
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. Common::Root::RootObjectClasses::RootEntity::id
OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object.
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
================== ========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== ========================================================
Data Types
----------
CityQualifiers
~~~~~~~~~~~~~~
Applied stereotypes:
- Preliminary
================== ======== ========= ========== ================================== ========================================================
**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description**
cityName String 1 RW Reference Name of City, Township, or Parish
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
cityDivision String 0..1 RW Reference Name of city division, ex. Borough, District, Ward, Chou
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
cityNeighborhood String 0..1 RW Reference Name of neighborhood, ex. Block, Street group
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
================== ======== ========= ========== ================================== ========================================================
CivicAddress
~~~~~~~~~~~~
Applied stereotypes:
- Preliminary
=================== =================== ========= ========== ================================== ==============================================================================================================================================================================================================================
**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description**
country String 1 RW Reference The name of the country
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
state String 0..1 RW Reference The name of the state or province
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
region String 0..1 RW Reference The name of the region
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
postalCode String 0..1 RW Reference The postal code or zip code
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
city CityQualifiers 0..1 RW Preliminary 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 RW Reference The street address
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
lata String 0..1 RW Preliminary 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 RW Preliminary Additional pre-defined qualifier fields for a structure including: unit, floor, room, desk
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
=================== =================== ========= ========== ================================== ==============================================================================================================================================================================================================================
GeoCoordinates
~~~~~~~~~~~~~~
Applied stereotypes:
- Preliminary
==================== ============ ========= ========== ================================== ======================================================================================================================
**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description**
mapDatum MapDatum 1 RW Reference Map Datum used for the coordinates given in this option.
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
latitude String 1 RW Reference Latitude in binary geodetic form. A 34-bit fixed-point value consisting of 9 bits of integer and 25 bits of fraction.
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
latitudeUncertainty String 0..1 RW Reference When mapDatum = WGS84, this field represents latitude uncertainty.
Uncertainty = 2 ^ ( 21 - x )
Preliminary x = 21 - ceil( log2( uncertainty ) )
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
longitude String 1 RW Reference Longitude in binary geodetic form. A 34-bit fixed-point value consisting of 9 bits of integer and 25 bits of fraction.
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
longitudeUncertainty String 0..1 RW Reference When mapDatum = WGS84, this field represents longitude uncertainty.
Uncertainty = 2 ^ ( 21 - x )
Preliminary x = 21 - ceil( log2( uncertainty ) )
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
altitude String 0..1 RW Reference A 30-bit value defined by the Altitude Type field.
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
altitudeUncertainty String 0..1 RW Reference When mapDatum = WGS84, this field represents altitude uncertainty.
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
altitudeUnit AltitudeUnit 0..1 RW Reference Defines the unit for the altitude value.
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
altitudeResolution String 0..1 RW Reference Encodes the number of high-order altitude bits that should be considered valid.
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
==================== ============ ========= ========== ================================== ======================================================================================================================
Identifier
~~~~~~~~~~
Applied stereotypes:
- Preliminary
StructureQualifiers
~~~~~~~~~~~~~~~~~~~
Applied stereotypes:
- Preliminary
================== ======== ========= ========== ================================== =================================================
**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description**
unit String 0..1 RW Reference Unit (apartment, suite)
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
floor String 0..1 RW Reference Floor
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
room String 0..1 RW Reference Room
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
desk String 0..1 RW Reference Seat, desk, cubicle, workstation
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
placementInfo String 0..1 RW Reference Additional placement information, ex. shelf, rack
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
poBox String 0..1 RW Reference Post office box number
Preliminary
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
================== ======== ========= ========== ================================== =================================================
TimePeriod
~~~~~~~~~~
A base / value business entity used to represent a period of time, between two timepoints
Applied stereotypes:
- Preliminary
================== ======== ========= ========== ================================== =================================================
**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description**
startDateTime DateTime 1 RW OpenModelAttribute An instant of time, starting at the TimePeriod
Notes:
- isInvariant: false If null, then represents to the beginning of time
- valueRange: no range constraint
- support: MANDATORY
endDateTime DateTime 1 RW OpenModelAttribute An instant of time, ending at the TimePeriod:
Notes:
- isInvariant: false If null, then represents to the end of time
- valueRange: no range constraint
- support: MANDATORY
================== ======== ========= ========== ================================== =================================================
Enumerations
------------
AltitudeUnit
~~~~~~~~~~~~
Contains Enumeration Literals:
- METER:
- FLOOR:
- FOOT:
MapDatum
~~~~~~~~
Contains Enumeration Literals:
- WGS84:
- NAD83 + NAVD88:
- NAD83 + MLLW:
|