blob: feecdac4517aff621a6fad1cfaa8c3c9112864df [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// XdslXtuCPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL xTU-C performance monitoring history data
30const XdslXtuCPerformanceMonitoringHistoryDataClassID ClassID = ClassID(112)
31
32var xdslxtucperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// XdslXtuCPerformanceMonitoringHistoryData (class ID #112)
35// This ME collects PM data on the xTUC to xTUR path as seen from the xTU-C. Instances of this ME
36// 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 UNI.
42//
43// Attributes
44// Managed Entity Id
45// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
46// identical ID, this ME is implicitly linked to an instance of the PPTP xDSL UNI part 1. (R,
47// setbycreate) (mandatory) (2-bytes)
48//
49// Interval End Time
50// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
51// (mandatory) (1-byte)
52//
53// Threshold Data 1_2 Id
54// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
55// that contain PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)
56//
57// Loss Of Frame Seconds
58// Loss of frame seconds: (R) (mandatory) (2-bytes)
59//
60// Loss Of Signal Seconds
61// Loss of signal seconds: (R) (mandatory) (2-bytes)
62//
63// Loss Of Link Seconds
64// Loss of link seconds: (R) (mandatory) (2-bytes)
65//
66// Loss Of Power Seconds
67// Loss of power seconds: (R) (mandatory) (2-bytes)
68//
69// Errored Seconds Es
70// Errored seconds (ES): This attribute counts 1-s intervals with one or more CRC8 anomalies summed
71// over all received bearer channels, or one or more loss of signal (LOS) defects, or one or more
72// SEF defects, or one or more LPR defects. (R) (mandatory) (2-bytes)
73//
74// Severely Errored Seconds
75// (R) (mandatory) (2-bytes)
76//
77// Line Initializations
78// Line initializations: This attribute counts the total number of full initializations attempted
79// on the line, both successful and failed. (R) (mandatory) (2-bytes)
80//
81// Failed Line Initializations
82// Failed line initializations: This attribute counts the total number of failed full
83// initializations during the accumulation period. A failed full initialization occurs when
84// showtime is not reached at the end of the full initialization procedure. (R) (mandatory)
85// (2-bytes)
86//
87// Short Initializations
88// Short initializations: This attribute counts the total number of fast retrains or short
89// initializations attempted on the line, successful and failed. Fast retrain is defined in [ITUT
90// G.992.2]. Short initialization is defined in [ITUT-G.992.3] and [ITUT G.992.4]. (R) (optional)
91// (2-bytes)
92//
93// Failed Short Initializations
94// (R) (optional) (2-bytes)
95//
96// Fec Seconds
97// FEC seconds: This attribute counts seconds during which there was an FEC anomaly. (R)
98// (mandatory) (2-bytes)
99//
100// Unavailable Seconds
101// Unavailable seconds: This attribute counts 1-s intervals during which the xDSL UNI is
102// unavailable. The line becomes unavailable at the onset of 10 contiguous SES-Ls. The 10 SES-Ls
103// are included in unavailable time. Once unavailable, the line becomes available at the onset of
104// 10-contiguous seconds that are not severely errored. The 10-s with no SESLs are excluded from
105// unavailable time. Some attribute counts are inhibited during unavailability - see clause
106// 7.2.7.13 of [ITUT G.997.1]. (R) (mandatory) (2-bytes)
107//
108// Sos Success Count, Near End
109// SOS success count, near end: The SOS-SUCCESS-NE attribute is a count of the total number of
110// successful SOS procedures initiated by the near-end xTU on the line during the accumulation
111// period. Successful SOS is defined in clause-12.1.4 of [ITUT G.993.2]. (R) (optional) (2-bytes)
112//
113// Sos Success Count, Far End
114// SOS success count, far end: The SOS-SUCCESS-FE attribute is a count of the total number of
115// successful SOS procedures initiated by the far-end xTU on the line during the accumulation
116// period. Successful SOS is defined in clause 12.1.4 of [ITUT-G.993.2]. (R) (optional) (2-bytes)
117//
118type XdslXtuCPerformanceMonitoringHistoryData struct {
119 ManagedEntityDefinition
120 Attributes AttributeValueMap
121}
122
123func init() {
124 xdslxtucperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
125 Name: "XdslXtuCPerformanceMonitoringHistoryData",
126 ClassID: 112,
127 MessageTypes: mapset.NewSetWith(
128 Create,
129 Delete,
130 Get,
131 Set,
Chip Boling2d51f052021-02-09 09:04:15 -0600132 GetCurrentData,
Chip Boling6e27b352020-02-14 09:10:01 -0600133 ),
134 AllowedAttributeMask: 0xffff,
135 AttributeDefinitions: AttributeDefinitionMap{
136 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
137 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
138 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
139 3: Uint16Field("LossOfFrameSeconds", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
140 4: Uint16Field("LossOfSignalSeconds", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
141 5: Uint16Field("LossOfLinkSeconds", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
142 6: Uint16Field("LossOfPowerSeconds", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
143 7: Uint16Field("ErroredSecondsEs", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
144 8: Uint16Field("SeverelyErroredSeconds", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
145 9: Uint16Field("LineInitializations", CounterAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
146 10: Uint16Field("FailedLineInitializations", CounterAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
147 11: Uint16Field("ShortInitializations", CounterAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, true, false, 11),
148 12: Uint16Field("FailedShortInitializations", CounterAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, true, false, 12),
149 13: Uint16Field("FecSeconds", CounterAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13),
150 14: Uint16Field("UnavailableSeconds", CounterAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14),
151 15: Uint16Field("SosSuccessCount,NearEnd", CounterAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, true, false, 15),
152 16: Uint16Field("SosSuccessCount,FarEnd", CounterAttributeType, 0x0001, 0, mapset.NewSetWith(Read), false, true, false, 16),
153 },
154 Access: CreatedByOlt,
155 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600156 Alarms: AlarmMap{
157 0: "Loss of frame seconds",
158 1: "Loss of signal seconds",
159 2: "Loss of link seconds",
160 3: "Loss of power seconds",
161 4: "Errored seconds",
162 5: "Severely errored seconds",
163 6: "Line initializations",
164 7: "Failed line initializations",
165 8: "Short initializations",
166 9: "Failed short initializations",
167 10: "FEC seconds",
168 11: "Unavailable seconds",
169 },
Chip Boling6e27b352020-02-14 09:10:01 -0600170 }
171}
172
173// NewXdslXtuCPerformanceMonitoringHistoryData (class ID 112) creates the basic
174// Managed Entity definition that is used to validate an ME of this type that
175// is received from or transmitted to the OMCC.
176func NewXdslXtuCPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
177 return NewManagedEntity(*xdslxtucperformancemonitoringhistorydataBME, params...)
178}