blob: b990013d556633a839f25bf439a0f6e94f6a62ea [file] [log] [blame]
Chip Boling115c7912021-02-17 10:34:54 -06001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
3 * Copyright 2020-present Open Networking Foundation
4
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
8
9 * http://www.apache.org/licenses/LICENSE-2.0
10
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 */
17/*
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
24package generated
25
26import "github.com/deckarep/golang-set"
27
28// FecPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity FEC performance monitoring history data
30const FecPerformanceMonitoringHistoryDataClassID ClassID = ClassID(312)
31
32var fecperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// FecPerformanceMonitoringHistoryData (class ID #312)
35// This ME collects PM data associated with PON downstream forward error correction (FEC) counters.
36// Instances of this 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 instance of the ANI-G ME or an instance of the time
42// and wavelength division multiplexing (TWDM) channel ME.
43//
44// Attributes
45// Managed Entity Id
46// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
47// identical ID, this ME is implicitly linked to an instance of the ANI-G or a TWDM channel. (R,
48// setbycreate) (mandatory) (2-bytes)
49//
50// Interval End Time
51// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
52// (mandatory) (1-byte)
53//
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 Bytes
60// Corrected bytes: This attribute counts the number of bytes that were corrected by the FEC
61// function. (R) (mandatory) (4-bytes)
62//
63// Corrected Code Words
64// Corrected code words: This attribute counts the code words that were corrected by the FEC
65// function. (R) (mandatory) (4-bytes)
66//
67// Uncorrectable Code Words
68// Uncorrectable code words: This attribute counts errored code words that could not be corrected
69// by the FEC function. (R) (mandatory) (4-bytes)
70//
71// Total Code Words
72// Total code words: This attribute counts the total received code words. (R) (mandatory) (4-bytes)
73//
74// Fec Seconds
75// FEC seconds: This attribute counts seconds during which there was an FEC anomaly. (R)
76// (mandatory) (2-bytes)
77//
78type FecPerformanceMonitoringHistoryData struct {
79 ManagedEntityDefinition
80 Attributes AttributeValueMap
81}
82
83func init() {
84 fecperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
85 Name: "FecPerformanceMonitoringHistoryData",
86 ClassID: 312,
87 MessageTypes: mapset.NewSetWith(
88 Create,
89 Delete,
90 Get,
91 Set,
92 GetCurrentData,
93 ),
94 AllowedAttributeMask: 0xfe00,
95 AttributeDefinitions: AttributeDefinitionMap{
96 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
97 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
98 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
99 3: Uint32Field("CorrectedBytes", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
100 4: Uint32Field("CorrectedCodeWords", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
101 5: Uint32Field("UncorrectableCodeWords", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
102 6: Uint32Field("TotalCodeWords", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
103 7: Uint16Field("FecSeconds", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
104 },
105 Access: CreatedByOlt,
106 Support: UnknownSupport,
107 Alarms: AlarmMap{
108 0: "Corrected bytes",
109 1: "Corrected code words",
110 2: "Uncorrectable code words",
111 4: "FEC seconds",
112 },
113 }
114}
115
116// NewFecPerformanceMonitoringHistoryData (class ID 312) creates the basic
117// Managed Entity definition that is used to validate an ME of this type that
118// is received from or transmitted to the OMCC.
119func NewFecPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
120 return NewManagedEntity(*fecperformancemonitoringhistorydataBME, params...)
121}