blob: ca81538a4ee20b0c5137aa0ff5d0fbcc9af198b9 [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
4
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
Andrea Campanella7167ebb2020-02-24 09:56:38 +01008
Chip Boling6e27b352020-02-14 09:10:01 -06009 * http://www.apache.org/licenses/LICENSE-2.0
Andrea Campanella7167ebb2020-02-24 09:56:38 +010010
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
30const XdslXtuRChannelPerformanceMonitoringHistoryDataClassID ClassID = ClassID(115)
31
32var xdslxturchannelperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// XdslXtuRChannelPerformanceMonitoringHistoryData (class ID #115)
35// 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
46// Managed entity ID: This attribute uniquely identifies each instance of this ME. The two MSBs of
47// the first byte are the bearer channel ID. Excluding the first 2-bits of the first byte, the
48// remaining part of the ME ID is identical to that of this ME's parent PPTP xDSL UNI part 1. (R,
49// setbycreate) (mandatory) (2-bytes)
50//
51// Interval End Time
52// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
53// (mandatory) (1-byte)
54//
55// Threshold Data 1_2 Id
56// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
57// contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
58// data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)
59//
60// Corrected Blocks
61// Corrected blocks: This attribute counts blocks received with errors that were corrected on this
62// channel. (R) (mandatory) (4-bytes)
63//
64// Uncorrected Blocks
65// Uncorrected blocks: This attribute counts blocks received with uncorrectable errors on this
66// channel. (R) (mandatory) (4-bytes)
67//
68// Transmitted Blocks
69// Transmitted blocks: This attribute counts encoded blocks transmitted on this channel. (R)
70// (mandatory) (4-bytes)
71//
72// Received Blocks
73// Received blocks: This attribute counts encoded blocks received on this channel. (R) (mandatory)
74// (4-bytes)
75//
76// Code Violations
77// Code violations: This attribute counts FEBE anomalies reported in the downstream bearer channel.
78// If the CRC is applied over multiple bearer channels, then each related FEBE anomaly increments
79// each of the counters related to the individual bearer channels. (R) (mandatory) (2-bytes)
80//
81// Forward Error Corrections
82// Forward error corrections: This attribute counts FFEC anomalies reported in the downstream
83// bearer channel. If FEC is applied over multiple bearer channels, each related FFEC anomaly
84// increments each of the counters related to the individual bearer channels. (R) (mandatory)
85// (2-bytes)
86//
87type XdslXtuRChannelPerformanceMonitoringHistoryData struct {
88 ManagedEntityDefinition
89 Attributes AttributeValueMap
90}
91
92func init() {
93 xdslxturchannelperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
94 Name: "XdslXtuRChannelPerformanceMonitoringHistoryData",
95 ClassID: 115,
96 MessageTypes: mapset.NewSetWith(
97 Create,
98 Delete,
99 Get,
100 Set,
Chip Boling2d51f052021-02-09 09:04:15 -0600101 GetCurrentData,
Chip Boling6e27b352020-02-14 09:10:01 -0600102 ),
103 AllowedAttributeMask: 0xff00,
104 AttributeDefinitions: AttributeDefinitionMap{
105 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
106 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
107 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
108 3: Uint32Field("CorrectedBlocks", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
109 4: Uint32Field("UncorrectedBlocks", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
110 5: Uint32Field("TransmittedBlocks", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
111 6: Uint32Field("ReceivedBlocks", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
112 7: Uint16Field("CodeViolations", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
113 8: Uint16Field("ForwardErrorCorrections", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
114 },
115 Access: CreatedByOlt,
116 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600117 Alarms: AlarmMap{
118 0: "Corrected blocks",
119 1: "Uncorrected blocks",
120 2: "Code violations",
121 3: "Forward error corrections",
122 },
Chip Boling6e27b352020-02-14 09:10:01 -0600123 }
124}
125
126// NewXdslXtuRChannelPerformanceMonitoringHistoryData (class ID 115) creates the basic
127// Managed Entity definition that is used to validate an ME of this type that
128// is received from or transmitted to the OMCC.
129func NewXdslXtuRChannelPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
130 return NewManagedEntity(*xdslxturchannelperformancemonitoringhistorydataBME, params...)
131}