Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net) |
Andrea Campanella | 7167ebb | 2020-02-24 09:56:38 +0100 | [diff] [blame] | 3 | * Copyright 2020-present Open Networking Foundation |
| 4 | |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 5 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | * you may not use this file except in compliance with the License. |
| 7 | * You may obtain a copy of the License at |
Andrea Campanella | 7167ebb | 2020-02-24 09:56:38 +0100 | [diff] [blame] | 8 | |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
Andrea Campanella | 7167ebb | 2020-02-24 09:56:38 +0100 | [diff] [blame] | 10 | |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | * See the License for the specific language governing permissions and |
| 15 | * limitations under the License. |
| 16 | */ |
Chip Boling | 34ebcb6 | 2021-02-02 12:13:58 -0600 | [diff] [blame] | 17 | /* |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 18 | * NOTE: This file was generated, manual edits will be overwritten! |
| 19 | * |
| 20 | * Generated by 'goCodeGenerator.py': |
| 21 | * https://github.com/cboling/OMCI-parser/README.md |
| 22 | */ |
| 23 | |
| 24 | package generated |
| 25 | |
| 26 | import "github.com/deckarep/golang-set" |
| 27 | |
| 28 | // GemPortNetworkCtpPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI |
| 29 | // Managed entity GEM port network CTP performance monitoring history data |
Chip Boling | 610117d | 2021-09-09 11:24:34 -0500 | [diff] [blame^] | 30 | const GemPortNetworkCtpPerformanceMonitoringHistoryDataClassID = ClassID(341) // 0x0155 |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 31 | |
| 32 | var gemportnetworkctpperformancemonitoringhistorydataBME *ManagedEntityDefinition |
| 33 | |
Chip Boling | 610117d | 2021-09-09 11:24:34 -0500 | [diff] [blame^] | 34 | // GemPortNetworkCtpPerformanceMonitoringHistoryData (Class ID: #341 / 0x0155) |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 35 | // This ME collects GEM frame PM data associated with a GEM port network CTP. Instances of this ME |
| 36 | // are created and deleted by the OLT. |
| 37 | // |
| 38 | // NOTE 1 - One might expect to find some form of impaired or discarded frame count associated with |
| 39 | // a GEM port. However, the only impairment that might be detected at the GEM frame level would be |
| 40 | // a corrupted GEM frame header. In this case, no part of the header could be considered reliable |
| 41 | // including the port ID. For this reason, there is no impaired or discarded frame count in this |
| 42 | // ME. |
| 43 | // |
| 44 | // NOTE 2 - This ME replaces the GEM port performance history data ME and is preferred for new |
| 45 | // implementations. |
| 46 | // |
| 47 | // For a complete discussion of generic PM architecture, refer to clause I.4. |
| 48 | // |
| 49 | // Relationships |
| 50 | // An instance of this ME is associated with an instance of the GEM port network CTP ME. |
| 51 | // |
| 52 | // Attributes |
| 53 | // Managed Entity Id |
Chip Boling | 610117d | 2021-09-09 11:24:34 -0500 | [diff] [blame^] | 54 | // This attribute uniquely identifies each instance of this ME. Through an identical ID, this ME is |
| 55 | // implicitly linked to an instance of the GEM port network CTP. (R, setbycreate) (mandatory) |
| 56 | // (2-bytes) |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 57 | // |
| 58 | // Interval End Time |
Chip Boling | 610117d | 2021-09-09 11:24:34 -0500 | [diff] [blame^] | 59 | // This attribute identifies the most recently finished 15-min interval. (R) (mandatory) (1-byte) |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 60 | // |
| 61 | // Threshold Data 1_2 Id |
| 62 | // Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that |
| 63 | // contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold |
| 64 | // data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes) |
| 65 | // |
| 66 | // Transmitted Gem Frames |
Chip Boling | 610117d | 2021-09-09 11:24:34 -0500 | [diff] [blame^] | 67 | // This attribute counts GEM frames transmitted on the monitored GEM port. (R) (mandatory) |
| 68 | // (4-bytes) |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 69 | // |
| 70 | // Received Gem Frames |
Chip Boling | 610117d | 2021-09-09 11:24:34 -0500 | [diff] [blame^] | 71 | // This attribute counts GEM frames received correctly on the monitored GEM port. A correctly |
| 72 | // received GEM frame is one that does not contain uncorrectable errors and has a valid header |
| 73 | // error check (HEC). (R) (mandatory) (4-bytes) |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 74 | // |
| 75 | // Received Payload Bytes |
Chip Boling | 610117d | 2021-09-09 11:24:34 -0500 | [diff] [blame^] | 76 | // This attribute counts user payload bytes received on the monitored GEM port. (R) (mandatory) |
| 77 | // (8-bytes) |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 78 | // |
| 79 | // Transmitted Payload Bytes |
Chip Boling | 610117d | 2021-09-09 11:24:34 -0500 | [diff] [blame^] | 80 | // This attribute counts user payload bytes transmitted on the monitored GEM port. (R) (mandatory) |
| 81 | // (8-bytes) |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 82 | // |
| 83 | // Encryption Key Errors |
Chip Boling | 610117d | 2021-09-09 11:24:34 -0500 | [diff] [blame^] | 84 | // NOTE 3 - GEM PM ignores idle GEM frames. |
| 85 | // |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 86 | // NOTE 4 - GEM PM counts each non-idle GEM frame, whether it contains an entire user frame or only |
| 87 | // a fragment of a user frame. |
| 88 | // |
Chip Boling | 610117d | 2021-09-09 11:24:34 -0500 | [diff] [blame^] | 89 | // This attribute is defined in ITU-T G.987 systems only. It counts GEM frames with erroneous |
| 90 | // encryption key indexes. If the GEM port is not encrypted, this attribute counts any frame with a |
| 91 | // key index not equal to 0. If the GEM port is encrypted, this attribute counts any frame whose |
| 92 | // key index specifies a key that is not known to the ONU. (R) (optional) (4-bytes) |
| 93 | // |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 94 | type GemPortNetworkCtpPerformanceMonitoringHistoryData struct { |
| 95 | ManagedEntityDefinition |
| 96 | Attributes AttributeValueMap |
| 97 | } |
| 98 | |
| 99 | func init() { |
| 100 | gemportnetworkctpperformancemonitoringhistorydataBME = &ManagedEntityDefinition{ |
| 101 | Name: "GemPortNetworkCtpPerformanceMonitoringHistoryData", |
| 102 | ClassID: 341, |
| 103 | MessageTypes: mapset.NewSetWith( |
| 104 | Create, |
| 105 | Delete, |
| 106 | Get, |
| 107 | Set, |
Chip Boling | 2d51f05 | 2021-02-09 09:04:15 -0600 | [diff] [blame] | 108 | GetCurrentData, |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 109 | ), |
| 110 | AllowedAttributeMask: 0xfe00, |
| 111 | AttributeDefinitions: AttributeDefinitionMap{ |
| 112 | 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0), |
| 113 | 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1), |
| 114 | 2: Uint16Field("ThresholdData12Id", PointerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2), |
| 115 | 3: Uint32Field("TransmittedGemFrames", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3), |
| 116 | 4: Uint32Field("ReceivedGemFrames", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4), |
| 117 | 5: Uint64Field("ReceivedPayloadBytes", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5), |
| 118 | 6: Uint64Field("TransmittedPayloadBytes", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6), |
| 119 | 7: Uint32Field("EncryptionKeyErrors", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, true, false, 7), |
| 120 | }, |
| 121 | Access: CreatedByOlt, |
| 122 | Support: UnknownSupport, |
Chip Boling | 34ebcb6 | 2021-02-02 12:13:58 -0600 | [diff] [blame] | 123 | Alarms: AlarmMap{ |
| 124 | 1: "Encryption key errors", |
| 125 | }, |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 126 | } |
| 127 | } |
| 128 | |
| 129 | // NewGemPortNetworkCtpPerformanceMonitoringHistoryData (class ID 341) creates the basic |
| 130 | // Managed Entity definition that is used to validate an ME of this type that |
| 131 | // is received from or transmitted to the OMCC. |
| 132 | func NewGemPortNetworkCtpPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) { |
| 133 | return NewManagedEntity(*gemportnetworkctpperformancemonitoringhistorydataBME, params...) |
| 134 | } |