blob: 46f31f8d40d08ae02913fe8a737fc79642108579 [file] [log] [blame]
Chip Boling6e27b352020-02-14 09:10:01 -06001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
Andrea Campanella7167ebb2020-02-24 09:56:38 +01003 * Copyright 2020-present Open Networking Foundation
Chip Boling8cdd6392022-01-27 08:43:37 -06004 *
Chip Boling6e27b352020-02-14 09:10:01 -06005 * 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
Chip Boling8cdd6392022-01-27 08:43:37 -06008 *
Chip Boling6e27b352020-02-14 09:10:01 -06009 * http://www.apache.org/licenses/LICENSE-2.0
Chip Boling8cdd6392022-01-27 08:43:37 -060010 *
Chip Boling6e27b352020-02-14 09:10:01 -060011 * 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 Boling34ebcb62021-02-02 12:13:58 -060017/*
Chip Boling6e27b352020-02-14 09:10:01 -060018 * 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
24package generated
25
26import "github.com/deckarep/golang-set"
27
28// XdslXtuRChannelPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL xTU-R channel performance monitoring history data
Chip Boling610117d2021-09-09 11:24:34 -050030const XdslXtuRChannelPerformanceMonitoringHistoryDataClassID = ClassID(115) // 0x0073
Chip Boling6e27b352020-02-14 09:10:01 -060031
32var xdslxturchannelperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
Chip Boling610117d2021-09-09 11:24:34 -050034// XdslXtuRChannelPerformanceMonitoringHistoryData (Class ID: #115 / 0x0073)
Chip Boling6e27b352020-02-14 09:10:01 -060035// This ME collects PM data of the xTUC to xTUR channel as seen from the xTU-R. Instances of this
36// ME are created and deleted by the OLT.
37//
38// For a complete discussion of generic PM architecture, refer to clause I.4.
39//
40// Relationships
41// An instance of this ME is associated with an xDSL bearer channel. Several instances may
42// therefore be associated with an xDSL UNI.
43//
44// Attributes
45// Managed Entity Id
Chip Boling610117d2021-09-09 11:24:34 -050046// This attribute uniquely identifies each instance of this ME. The two MSBs of the first byte are
47// the bearer channel ID. Excluding the first 2-bits of the first byte, the remaining part of the
48// ME ID is identical to that of this ME's parent PPTP xDSL UNI part 1. (R, setbycreate)
49// (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060050//
51// Interval End Time
Chip Boling610117d2021-09-09 11:24:34 -050052// This attribute identifies the most recently finished 15-min interval. (R) (mandatory) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060053//
54// Threshold Data 1_2 Id
55// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
56// contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
57// data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)
58//
59// Corrected Blocks
Chip Boling610117d2021-09-09 11:24:34 -050060// This attribute counts blocks received with errors that were corrected on this channel. (R)
Chip Boling6e27b352020-02-14 09:10:01 -060061// (mandatory) (4-bytes)
62//
Chip Boling610117d2021-09-09 11:24:34 -050063// Uncorrected Blocks
64// This attribute counts blocks received with uncorrectable errors on this channel. (R) (mandatory)
Chip Boling6e27b352020-02-14 09:10:01 -060065// (4-bytes)
66//
Chip Boling610117d2021-09-09 11:24:34 -050067// Transmitted Blocks
68// This attribute counts encoded blocks transmitted on this channel. (R) (mandatory) (4-bytes)
69//
70// Received Blocks
71// This attribute counts encoded blocks received on this channel. (R) (mandatory) (4-bytes)
72//
Chip Boling6e27b352020-02-14 09:10:01 -060073// Code Violations
Chip Boling610117d2021-09-09 11:24:34 -050074// This attribute counts FEBE anomalies reported in the downstream bearer channel. If the CRC is
75// applied over multiple bearer channels, then each related FEBE anomaly increments each of the
76// counters related to the individual bearer channels. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060077//
78// Forward Error Corrections
Chip Boling610117d2021-09-09 11:24:34 -050079// This attribute counts FFEC anomalies reported in the downstream bearer channel. If FEC is
80// applied over multiple bearer channels, each related FFEC anomaly increments each of the counters
81// related to the individual bearer channels. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060082//
83type XdslXtuRChannelPerformanceMonitoringHistoryData struct {
84 ManagedEntityDefinition
85 Attributes AttributeValueMap
86}
87
Chip Boling8cdd6392022-01-27 08:43:37 -060088// Attribute name constants
89
90const XdslXtuRChannelPerformanceMonitoringHistoryData_IntervalEndTime = "IntervalEndTime"
91const XdslXtuRChannelPerformanceMonitoringHistoryData_ThresholdData12Id = "ThresholdData12Id"
92const XdslXtuRChannelPerformanceMonitoringHistoryData_CorrectedBlocks = "CorrectedBlocks"
93const XdslXtuRChannelPerformanceMonitoringHistoryData_UncorrectedBlocks = "UncorrectedBlocks"
94const XdslXtuRChannelPerformanceMonitoringHistoryData_TransmittedBlocks = "TransmittedBlocks"
95const XdslXtuRChannelPerformanceMonitoringHistoryData_ReceivedBlocks = "ReceivedBlocks"
96const XdslXtuRChannelPerformanceMonitoringHistoryData_CodeViolations = "CodeViolations"
97const XdslXtuRChannelPerformanceMonitoringHistoryData_ForwardErrorCorrections = "ForwardErrorCorrections"
98
Chip Boling6e27b352020-02-14 09:10:01 -060099func init() {
100 xdslxturchannelperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
101 Name: "XdslXtuRChannelPerformanceMonitoringHistoryData",
Chip Boling8cdd6392022-01-27 08:43:37 -0600102 ClassID: XdslXtuRChannelPerformanceMonitoringHistoryDataClassID,
Chip Boling6e27b352020-02-14 09:10:01 -0600103 MessageTypes: mapset.NewSetWith(
104 Create,
105 Delete,
106 Get,
107 Set,
Chip Boling2d51f052021-02-09 09:04:15 -0600108 GetCurrentData,
Chip Boling6e27b352020-02-14 09:10:01 -0600109 ),
110 AllowedAttributeMask: 0xff00,
111 AttributeDefinitions: AttributeDefinitionMap{
Chip Boling8cdd6392022-01-27 08:43:37 -0600112 0: Uint16Field(ManagedEntityID, PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
113 1: ByteField(XdslXtuRChannelPerformanceMonitoringHistoryData_IntervalEndTime, UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
114 2: Uint16Field(XdslXtuRChannelPerformanceMonitoringHistoryData_ThresholdData12Id, UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
115 3: Uint32Field(XdslXtuRChannelPerformanceMonitoringHistoryData_CorrectedBlocks, CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
116 4: Uint32Field(XdslXtuRChannelPerformanceMonitoringHistoryData_UncorrectedBlocks, CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
117 5: Uint32Field(XdslXtuRChannelPerformanceMonitoringHistoryData_TransmittedBlocks, CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
118 6: Uint32Field(XdslXtuRChannelPerformanceMonitoringHistoryData_ReceivedBlocks, CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
119 7: Uint16Field(XdslXtuRChannelPerformanceMonitoringHistoryData_CodeViolations, CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
120 8: Uint16Field(XdslXtuRChannelPerformanceMonitoringHistoryData_ForwardErrorCorrections, CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
Chip Boling6e27b352020-02-14 09:10:01 -0600121 },
122 Access: CreatedByOlt,
123 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600124 Alarms: AlarmMap{
125 0: "Corrected blocks",
126 1: "Uncorrected blocks",
127 2: "Code violations",
128 3: "Forward error corrections",
129 },
Chip Boling6e27b352020-02-14 09:10:01 -0600130 }
131}
132
133// NewXdslXtuRChannelPerformanceMonitoringHistoryData (class ID 115) creates the basic
134// Managed Entity definition that is used to validate an ME of this type that
135// is received from or transmitted to the OMCC.
136func NewXdslXtuRChannelPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
137 return NewManagedEntity(*xdslxturchannelperformancemonitoringhistorydataBME, params...)
138}