Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -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; |
| 17 | |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableSet; |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 19 | import org.onlab.util.Frequency; |
Marc De Leenheer | b0fb41d | 2015-12-03 22:16:53 -0800 | [diff] [blame] | 20 | import org.onlab.util.Spectrum; |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 21 | |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 22 | import java.util.List; |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 23 | import java.util.Objects; |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 24 | import java.util.Set; |
| 25 | import java.util.SortedSet; |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 26 | import java.util.stream.Collectors; |
| 27 | import java.util.stream.IntStream; |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 28 | |
| 29 | import static com.google.common.base.Preconditions.checkArgument; |
| 30 | import static com.google.common.base.Preconditions.checkNotNull; |
HIGUCHI Yuta | ca8cb4e | 2015-12-11 13:57:05 -0800 | [diff] [blame] | 31 | import static org.onosproject.net.ChannelSpacing.CHL_12P5GHZ; |
| 32 | import static org.onosproject.net.ChannelSpacing.CHL_6P25GHZ; |
| 33 | import static org.onosproject.net.GridType.DWDM; |
| 34 | import static org.onosproject.net.GridType.FLEX; |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 35 | |
| 36 | /** |
| 37 | * Implementation of Lambda representing OCh (Optical Channel) Signal. |
| 38 | * |
| 39 | * <p> |
| 40 | * See ITU G.709 "Interfaces for the Optical Transport Network (OTN)". |
HIGUCHI Yuta | ca8cb4e | 2015-12-11 13:57:05 -0800 | [diff] [blame] | 41 | * ITU G.694.1 "Spectral grids for WDM applications: DWDM frequency grid". |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 42 | * </p> |
| 43 | */ |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 44 | public class OchSignal implements Lambda { |
| 45 | |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 46 | public static final Set<Integer> FIXED_GRID_SLOT_GRANULARITIES = ImmutableSet.of(1, 2, 4, 8); |
Marc De Leenheer | c973308 | 2015-06-04 12:22:38 -0700 | [diff] [blame] | 47 | private static final GridType DEFAULT_OCH_GRIDTYPE = GridType.DWDM; |
| 48 | private static final ChannelSpacing DEFAULT_CHANNEL_SPACING = ChannelSpacing.CHL_50GHZ; |
| 49 | |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 50 | private final GridType gridType; |
| 51 | private final ChannelSpacing channelSpacing; |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 52 | // Nominal central frequency = 193.1 THz + spacingMultiplier * channelSpacing |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 53 | private final int spacingMultiplier; |
| 54 | // Slot width = slotGranularity * 12.5 GHz |
| 55 | private final int slotGranularity; |
| 56 | |
| 57 | /** |
| 58 | * Creates an instance with the specified arguments. |
Sho SHIMIZU | 4fea4fd | 2015-05-07 11:50:23 -0700 | [diff] [blame] | 59 | * It it recommended to use {@link Lambda#ochSignal(GridType, ChannelSpacing, int, int)} |
| 60 | * unless you want to use the concrete type, OchSignal, directly. |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 61 | * |
| 62 | * @param gridType grid type |
| 63 | * @param channelSpacing channel spacing |
| 64 | * @param spacingMultiplier channel spacing multiplier |
| 65 | * @param slotGranularity slot width granularity |
| 66 | */ |
Sho SHIMIZU | 4fea4fd | 2015-05-07 11:50:23 -0700 | [diff] [blame] | 67 | public OchSignal(GridType gridType, ChannelSpacing channelSpacing, |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 68 | int spacingMultiplier, int slotGranularity) { |
| 69 | this.gridType = checkNotNull(gridType); |
| 70 | this.channelSpacing = checkNotNull(channelSpacing); |
Marc De Leenheer | 1afa2a0 | 2015-05-13 09:18:07 -0700 | [diff] [blame] | 71 | // Negative values are permitted for spacingMultiplier |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 72 | this.spacingMultiplier = spacingMultiplier; |
Marc De Leenheer | 1afa2a0 | 2015-05-13 09:18:07 -0700 | [diff] [blame] | 73 | checkArgument(slotGranularity > 0, "slotGranularity must be larger than 0, received %s", slotGranularity); |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 74 | this.slotGranularity = slotGranularity; |
| 75 | } |
| 76 | |
| 77 | /** |
HIGUCHI Yuta | ca8cb4e | 2015-12-11 13:57:05 -0800 | [diff] [blame] | 78 | * Creates an instance of {@link OchSignal} representing a flex grid frequency slot. |
| 79 | * @param index slot index (relative to "the center frequency" 193.1THz) |
| 80 | * @return FlexGrid {@link OchSignal} |
| 81 | */ |
| 82 | public static OchSignal newFlexGridSlot(int index) { |
| 83 | return new OchSignal(FLEX, CHL_6P25GHZ, index, 1); |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Creates an instance of {@link OchSignal} representing a fixed DWDM frequency slot. |
| 88 | * @param spacing channel spacing |
| 89 | * @param index slot index (relative to "the center frequency" 193.1THz) |
| 90 | * @return DWDM {@link OchSignal} |
| 91 | */ |
| 92 | public static OchSignal newDwdmSlot(ChannelSpacing spacing, int index) { |
| 93 | return new OchSignal(DWDM, spacing, index, |
| 94 | (int) (spacing.frequency().asHz() / CHL_12P5GHZ.frequency().asHz())); |
| 95 | } |
| 96 | |
| 97 | /** |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 98 | * Returns grid type. |
| 99 | * |
| 100 | * @return grid type |
| 101 | */ |
| 102 | public GridType gridType() { |
| 103 | return gridType; |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Returns channel spacing. |
| 108 | * |
| 109 | * @return channel spacing |
| 110 | */ |
| 111 | public ChannelSpacing channelSpacing() { |
| 112 | return channelSpacing; |
| 113 | } |
| 114 | |
| 115 | /** |
| 116 | * Returns spacing multiplier. |
| 117 | * |
| 118 | * @return spacing multiplier |
| 119 | */ |
| 120 | public int spacingMultiplier() { |
| 121 | return spacingMultiplier; |
| 122 | } |
| 123 | |
| 124 | /** |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 125 | * Returns slot width granularity. |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 126 | * |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 127 | * @return slot width granularity |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 128 | */ |
| 129 | public int slotGranularity() { |
| 130 | return slotGranularity; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Returns central frequency in MHz. |
| 135 | * |
| 136 | * @return frequency in MHz |
| 137 | */ |
| 138 | public Frequency centralFrequency() { |
Marc De Leenheer | b0fb41d | 2015-12-03 22:16:53 -0800 | [diff] [blame] | 139 | return Spectrum.CENTER_FREQUENCY.add(channelSpacing().frequency().multiply(spacingMultiplier)); |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 140 | } |
| 141 | |
| 142 | /** |
| 143 | * Returns slot width. |
| 144 | * |
| 145 | * @return slot width |
| 146 | */ |
| 147 | public Frequency slotWidth() { |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 148 | return ChannelSpacing.CHL_12P5GHZ.frequency().multiply(slotGranularity); |
| 149 | } |
| 150 | |
| 151 | /** |
| 152 | * Convert fixed grid OCh signal to sorted set of flex grid slots with 6.25 GHz spacing and 12.5 GHz slot width. |
| 153 | * |
| 154 | * @param ochSignal fixed grid lambda |
| 155 | * @return sorted set of flex grid OCh lambdas |
| 156 | */ |
| 157 | public static SortedSet<OchSignal> toFlexGrid(OchSignal ochSignal) { |
HIGUCHI Yuta | ee66aad | 2016-04-27 12:14:41 -0700 | [diff] [blame] | 158 | checkArgument(ochSignal.gridType() != GridType.FLEX, ochSignal.gridType()); |
| 159 | checkArgument(ochSignal.channelSpacing() != ChannelSpacing.CHL_6P25GHZ, ochSignal.channelSpacing()); |
| 160 | checkArgument(FIXED_GRID_SLOT_GRANULARITIES.contains(ochSignal.slotGranularity()), ochSignal.slotGranularity()); |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 161 | |
| 162 | int startMultiplier = (int) (1 - ochSignal.slotGranularity() + |
| 163 | ochSignal.spacingMultiplier() * ochSignal.channelSpacing().frequency().asHz() / |
| 164 | ChannelSpacing.CHL_6P25GHZ.frequency().asHz()); |
| 165 | |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 166 | return IntStream.range(0, ochSignal.slotGranularity()) |
| 167 | .mapToObj(i -> new OchSignal(GridType.FLEX, ChannelSpacing.CHL_6P25GHZ, startMultiplier + 2 * i, 1)) |
HIGUCHI Yuta | ca8cb4e | 2015-12-11 13:57:05 -0800 | [diff] [blame] | 168 | .collect(Collectors.toCollection(DefaultOchSignalComparator::newOchSignalTreeSet)); |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | /** |
| 172 | * Convert list of lambdas with flex grid 6.25 GHz spacing and 12.5 GHz width into fixed grid OCh signal. |
| 173 | * |
| 174 | * @param lambdas list of flex grid lambdas in sorted order |
| 175 | * @param spacing desired fixed grid spacing |
| 176 | * @return fixed grid lambda |
| 177 | */ |
| 178 | public static OchSignal toFixedGrid(List<OchSignal> lambdas, ChannelSpacing spacing) { |
| 179 | // Number of slots of 12.5 GHz that fit into requested spacing |
| 180 | int ratio = (int) (spacing.frequency().asHz() / ChannelSpacing.CHL_12P5GHZ.frequency().asHz()); |
HIGUCHI Yuta | ee66aad | 2016-04-27 12:14:41 -0700 | [diff] [blame] | 181 | checkArgument(lambdas.size() == ratio, "%s != %s", lambdas.size(), ratio); |
| 182 | lambdas.forEach(x -> checkArgument(x.gridType() == GridType.FLEX, x.gridType())); |
| 183 | lambdas.forEach(x -> checkArgument(x.channelSpacing() == ChannelSpacing.CHL_6P25GHZ, x.channelSpacing())); |
| 184 | lambdas.forEach(x -> checkArgument(x.slotGranularity() == 1, x.slotGranularity())); |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 185 | // Consecutive lambdas (multiplier increments by 2 because spacing is 6.25 GHz but slot width is 12.5 GHz) |
| 186 | IntStream.range(1, lambdas.size()) |
| 187 | .forEach(i -> checkArgument( |
| 188 | lambdas.get(i).spacingMultiplier() == lambdas.get(i - 1).spacingMultiplier() + 2)); |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 189 | // Multiplier sits in middle of given lambdas, then convert from 6.25 to requested spacing |
HIGUCHI Yuta | ca8cb4e | 2015-12-11 13:57:05 -0800 | [diff] [blame] | 190 | int spacingMultiplier = lambdas.stream() |
| 191 | .mapToInt(OchSignal::spacingMultiplier) |
| 192 | .sum() / lambdas.size() |
| 193 | / (int) (spacing.frequency().asHz() / CHL_6P25GHZ.frequency().asHz()); |
Marc De Leenheer | 2c30530 | 2015-12-07 21:37:44 -0800 | [diff] [blame] | 194 | |
| 195 | return new OchSignal(GridType.DWDM, spacing, spacingMultiplier, lambdas.size()); |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 196 | } |
| 197 | |
| 198 | @Override |
| 199 | public int hashCode() { |
| 200 | return Objects.hash(gridType, channelSpacing, spacingMultiplier, slotGranularity); |
| 201 | } |
| 202 | |
| 203 | @Override |
| 204 | public boolean equals(Object obj) { |
| 205 | if (this == obj) { |
| 206 | return true; |
| 207 | } |
| 208 | if (!(obj instanceof OchSignal)) { |
| 209 | return false; |
| 210 | } |
| 211 | final OchSignal other = (OchSignal) obj; |
| 212 | return Objects.equals(this.gridType, other.gridType) |
| 213 | && Objects.equals(this.channelSpacing, other.channelSpacing) |
| 214 | && Objects.equals(this.spacingMultiplier, other.spacingMultiplier) |
| 215 | && Objects.equals(this.slotGranularity, other.slotGranularity); |
| 216 | } |
| 217 | |
| 218 | @Override |
| 219 | public String toString() { |
Andrea Campanella | b65d99d | 2019-03-01 12:07:11 +0100 | [diff] [blame] | 220 | return String.format("%s{%+d x %.2fGHz +/- %.2fGHz}", |
Naoki Shiota | 0b5ccd2 | 2015-12-11 15:47:01 -0800 | [diff] [blame] | 221 | this.getClass().getSimpleName(), |
| 222 | spacingMultiplier, |
Marc De Leenheer | 6215fbc | 2016-02-05 16:14:08 -0800 | [diff] [blame] | 223 | (double) channelSpacing.frequency().asHz() / Frequency.ofGHz(1).asHz(), |
Andrea Campanella | b65d99d | 2019-03-01 12:07:11 +0100 | [diff] [blame] | 224 | (double) slotGranularity * ChannelSpacing.CHL_12P5GHZ.frequency().asHz() |
Naoki Shiota | 0b5ccd2 | 2015-12-11 15:47:01 -0800 | [diff] [blame] | 225 | / Frequency.ofGHz(1).asHz() / 2.0); |
Sho SHIMIZU | 91210a7 | 2015-04-29 12:54:28 -0700 | [diff] [blame] | 226 | } |
| 227 | } |