yjimmyy | b94f93b | 2016-07-11 16:03:48 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
yjimmyy | b94f93b | 2016-07-11 16:03:48 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.net.optical; |
| 17 | |
| 18 | import com.google.common.annotations.Beta; |
| 19 | |
| 20 | /** |
| 21 | * Collection of keys for annotation for optical devices. |
| 22 | */ |
| 23 | @Beta |
| 24 | public final class OpticalAnnotations { |
| 25 | |
| 26 | private OpticalAnnotations() {} |
| 27 | |
| 28 | /** |
Yuta HIGUCHI | c57ee90 | 2017-05-01 13:12:49 -0700 | [diff] [blame] | 29 | * Annotation key for minimum frequency in Hz. |
Jimmy Yan | d20e44f | 2016-09-09 13:32:46 -0700 | [diff] [blame] | 30 | * Value is expected to be an integer. |
| 31 | */ |
| 32 | public static final String MIN_FREQ_HZ = "minFrequency"; |
| 33 | |
| 34 | /** |
| 35 | * Annotation key for maximum frequency in Hz. |
| 36 | * Value is expected be an integer. |
| 37 | */ |
| 38 | public static final String MAX_FREQ_HZ = "maxFrequency"; |
| 39 | |
| 40 | /** |
| 41 | * Annotation key for grid in Hz. |
| 42 | * Value is expected to be an integer. |
| 43 | */ |
| 44 | public static final String GRID_HZ = "grid"; |
| 45 | |
| 46 | /** |
yjimmyy | b94f93b | 2016-07-11 16:03:48 -0700 | [diff] [blame] | 47 | * Annotation key for optical port's target power. |
Yuta HIGUCHI | c57ee90 | 2017-05-01 13:12:49 -0700 | [diff] [blame] | 48 | * Value is expected to be an integer in 0.01 dBm unit. |
yjimmyy | b94f93b | 2016-07-11 16:03:48 -0700 | [diff] [blame] | 49 | */ |
| 50 | public static final String TARGET_POWER = "targetPower"; |
| 51 | |
| 52 | /** |
Jimmy Jin | 1085239 | 2017-01-24 13:45:13 -0800 | [diff] [blame] | 53 | * Annotation key for optical port's current receiving power. |
Yuta HIGUCHI | c57ee90 | 2017-05-01 13:12:49 -0700 | [diff] [blame] | 54 | * Value is expected to be an integer in 0.01 dBm unit. |
yjimmyy | b94f93b | 2016-07-11 16:03:48 -0700 | [diff] [blame] | 55 | */ |
| 56 | public static final String CURRENT_POWER = "currentPower"; |
| 57 | |
| 58 | /** |
Jimmy Jin | 1085239 | 2017-01-24 13:45:13 -0800 | [diff] [blame] | 59 | * Annotation key for bidirectional optical port's transmitting power. |
Yuta HIGUCHI | c57ee90 | 2017-05-01 13:12:49 -0700 | [diff] [blame] | 60 | * Value is expected to be an integer in 0.01 dBm unit. |
Jimmy Jin | 1085239 | 2017-01-24 13:45:13 -0800 | [diff] [blame] | 61 | */ |
| 62 | public static final String OUTPUT_POWER = "ouputPower"; |
| 63 | |
| 64 | /** |
yjimmyy | b94f93b | 2016-07-11 16:03:48 -0700 | [diff] [blame] | 65 | * Annotation key for optical port's neighbor's DeviceId#toString(). |
| 66 | */ |
| 67 | public static final String NEIGHBOR_ID = "neighborDeviceId"; |
| 68 | |
| 69 | /** |
| 70 | * Annotation key for optical port's neighbor's PortNumber#toString(). |
Jimmy Yan | d20e44f | 2016-09-09 13:32:46 -0700 | [diff] [blame] | 71 | * Value is expected to be an integer. |
yjimmyy | b94f93b | 2016-07-11 16:03:48 -0700 | [diff] [blame] | 72 | */ |
| 73 | public static final String NEIGHBOR_PORT = "neighborPort"; |
Jimmy Jin | 1085239 | 2017-01-24 13:45:13 -0800 | [diff] [blame] | 74 | |
| 75 | /** |
| 76 | * Annotation key for optical port's status in receiving direction. |
| 77 | * Value is expected to be STATUS_IN_SERVICE or STATUS_OUT_SERVICE. |
| 78 | */ |
| 79 | public static final String INPUT_PORT_STATUS = "inputStatus"; |
| 80 | |
| 81 | /** |
| 82 | * Annotation key for optical port's status in transmitting direction. |
| 83 | * Value is expected to be STATUS_IN_SERVICE or STATUS_OUT_SERVICE. |
| 84 | */ |
| 85 | public static final String OUTPUT_PORT_STATUS = "ouputStatus"; |
| 86 | |
| 87 | /** |
| 88 | * Annotation value for optical port's in-service status. |
| 89 | */ |
| 90 | public static final String STATUS_IN_SERVICE = "inService"; |
| 91 | |
| 92 | /** |
| 93 | * Annotation value for optical port's out-of-service status. |
| 94 | */ |
| 95 | public static final String STATUS_OUT_SERVICE = "outOfService"; |
yjimmyy | b94f93b | 2016-07-11 16:03:48 -0700 | [diff] [blame] | 96 | } |