blob: caa6f425c182c7bd17fa3604f0e779a36d5c4baf [file] [log] [blame]
/*
* Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
* Copyright 2020-present Open Networking Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* NOTE: This file was generated, manual edits will be overwritten!
*
* Generated by 'goCodeGenerator.py':
* https://github.com/cboling/OMCI-parser/README.md
*/
package generated
import "github.com/deckarep/golang-set"
// XdslXtuCPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
// Managed entity xDSL xTU-C performance monitoring history data
const XdslXtuCPerformanceMonitoringHistoryDataClassID = ClassID(112) // 0x0070
var xdslxtucperformancemonitoringhistorydataBME *ManagedEntityDefinition
// XdslXtuCPerformanceMonitoringHistoryData (Class ID: #112 / 0x0070)
// This ME collects PM data on the xTUC to xTUR path as seen from the xTU-C. Instances of this ME
// are created and deleted by the OLT.
//
// For a complete discussion of generic PM architecture, refer to clause I.4.
//
// Relationships
// An instance of this ME is associated with an xDSL UNI.
//
// Attributes
// Managed Entity Id
// This attribute uniquely identifies each instance of this ME. Through an identical ID, this ME is
// implicitly linked to an instance of the PPTP xDSL UNI part 1. (R, setbycreate) (mandatory)
// (2-bytes)
//
// Interval End Time
// This attribute identifies the most recently finished 15-min interval. (R) (mandatory) (1-byte)
//
// Threshold Data 1_2 Id
// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
// that contain PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)
//
// Loss Of Frame Seconds
// (R) (mandatory) (2-bytes)
//
// Loss Of Signal Seconds
// (R) (mandatory) (2-bytes)
//
// Loss Of Link Seconds
// (R) (mandatory) (2-bytes)
//
// Loss Of Power Seconds
// (R) (mandatory) (2-bytes)
//
// Errored Seconds Es
// Errored seconds (ES): This attribute counts 1-s intervals with one or more CRC8 anomalies summed
// over all received bearer channels, or one or more loss of signal (LOS) defects, or one or more
// SEF defects, or one or more LPR defects. (R) (mandatory) (2-bytes)
//
// Severely Errored Seconds
// This attribute counts severely errored seconds (SES-L). An SES is declared if, during a 1-s
// interval, there were 18 or more CRC8 anomalies in one or more of the received bearer channels,
// or one or more LOS defects, or one or more SEF defects, or one or more LPR defects.
//
// If the relevant Recommendation ([ITUT G.992.3], [ITUT G.992.5] or [ITUT G.993.2]) supports a 1-s
// normalized CRC-8 anomaly counter increment, the 1-s SES counter follows this value instead of
// counting CRC-8 anomalies directly.
//
// If a common CRC is applied over multiple bearer channels, then each related CRC-8 anomaly is
// counted only once for the whole set of bearer channels over which the CRC is applied.
//
// (R) (mandatory) (2-bytes)
//
// Line Initializations
// This attribute counts the total number of full initializations attempted on the line, both
// successful and failed. (R) (mandatory) (2-bytes)
//
// Failed Line Initializations
// This attribute counts the total number of failed full initializations during the accumulation
// period. A failed full initialization occurs when showtime is not reached at the end of the full
// initialization procedure. (R) (mandatory) (2-bytes)
//
// Short Initializations
// This attribute counts the total number of fast retrains or short initializations attempted on
// the line, successful and failed. Fast retrain is defined in [ITUT G.992.2]. Short initialization
// is defined in [ITUT-G.992.3] and [ITUT G.992.4]. (R) (optional) (2-bytes)
//
// Failed Short Initializations
// This attribute counts the total number of failed fast retrains or short initializations during
// the accumulation period, e.g., when:
//
// - a CRC error is detected;
//
// - a timeout occurs;
//
// - a fast retrain profile is unknown.
//
// (R) (optional) (2-bytes)
//
// Fec Seconds
// This attribute counts seconds during which there was an FEC anomaly. (R) (mandatory) (2-bytes)
//
// Unavailable Seconds
// This attribute counts 1-s intervals during which the xDSL UNI is unavailable. The line becomes
// unavailable at the onset of 10 contiguous SES-Ls. The 10 SES-Ls are included in unavailable
// time. Once unavailable, the line becomes available at the onset of 10-contiguous seconds that
// are not severely errored. The 10-s with no SESLs are excluded from unavailable time. Some
// attribute counts are inhibited during unavailability - see clause 7.2.7.13 of [ITUT G.997.1].
// (R) (mandatory) (2-bytes)
//
// Sos Success Count, Near End
// The SOS-SUCCESS-NE attribute is a count of the total number of successful SOS procedures
// initiated by the near-end xTU on the line during the accumulation period. Successful SOS is
// defined in clause-12.1.4 of [ITUT G.993.2]. (R) (optional) (2-bytes)
//
// Sos Success Count, Far End
// The SOS-SUCCESS-FE attribute is a count of the total number of successful SOS procedures
// initiated by the far-end xTU on the line during the accumulation period. Successful SOS is
// defined in clause 12.1.4 of [ITUT-G.993.2]. (R) (optional) (2-bytes)
//
type XdslXtuCPerformanceMonitoringHistoryData struct {
ManagedEntityDefinition
Attributes AttributeValueMap
}
func init() {
xdslxtucperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
Name: "XdslXtuCPerformanceMonitoringHistoryData",
ClassID: 112,
MessageTypes: mapset.NewSetWith(
Create,
Delete,
Get,
Set,
GetCurrentData,
),
AllowedAttributeMask: 0xffff,
AttributeDefinitions: AttributeDefinitionMap{
0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
3: Uint16Field("LossOfFrameSeconds", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
4: Uint16Field("LossOfSignalSeconds", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
5: Uint16Field("LossOfLinkSeconds", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
6: Uint16Field("LossOfPowerSeconds", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
7: Uint16Field("ErroredSecondsEs", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
8: Uint16Field("SeverelyErroredSeconds", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
9: Uint16Field("LineInitializations", CounterAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
10: Uint16Field("FailedLineInitializations", CounterAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
11: Uint16Field("ShortInitializations", CounterAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, true, false, 11),
12: Uint16Field("FailedShortInitializations", CounterAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, true, false, 12),
13: Uint16Field("FecSeconds", CounterAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13),
14: Uint16Field("UnavailableSeconds", CounterAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14),
15: Uint16Field("SosSuccessCount,NearEnd", CounterAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, true, false, 15),
16: Uint16Field("SosSuccessCount,FarEnd", CounterAttributeType, 0x0001, 0, mapset.NewSetWith(Read), false, true, false, 16),
},
Access: CreatedByOlt,
Support: UnknownSupport,
Alarms: AlarmMap{
0: "Loss of frame seconds",
1: "Loss of signal seconds",
2: "Loss of link seconds",
3: "Loss of power seconds",
4: "Errored seconds",
5: "Severely errored seconds",
6: "Line initializations",
7: "Failed line initializations",
8: "Short initializations",
9: "Failed short initializations",
10: "FEC seconds",
11: "Unavailable seconds",
},
}
}
// NewXdslXtuCPerformanceMonitoringHistoryData (class ID 112) creates the basic
// Managed Entity definition that is used to validate an ME of this type that
// is received from or transmitted to the OMCC.
func NewXdslXtuCPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
return NewManagedEntity(*xdslxtucperformancemonitoringhistorydataBME, params...)
}