blob: c8d3a2a930b4311444be844680c6f49358e24042 [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 */
Andrea Campanella7167ebb2020-02-24 09:56:38 +010017 /*
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// TwdmChannelPhyLodsPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity TWDM channel PHY/LODS performance monitoring history data
30const TwdmChannelPhyLodsPerformanceMonitoringHistoryDataClassID ClassID = ClassID(444)
31
32var twdmchannelphylodsperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// TwdmChannelPhyLodsPerformanceMonitoringHistoryData (class ID #444)
35// This ME collects certain PM data associated with the slot/circuit pack, hosting one or more
36// ANI-G MEs, and a specific TWDM channel. 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 TWDM channel ME.
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 TWDM channel ME. (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 contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)
56//
57// Total Received Words Protected By Bit_Interleaved Parity _32 Bip_32
58// Total received words protected by bit-interleaved parity-32 (BIP-32): The count of 4-byte words
59// included in BIP-32 check. This is a product of the number of downstream FS frames received by
60// the size of the downstream FS frame after the FEC parity byte, if any, have been removed. The
61// count applies to the entire downstream data flow, whether or not addressed to that ONT. (R)
62// (mandatory) (8-bytes)
63//
64// Bip_32 Bit Error Count
65// BIP-32 bit error count: Count of the bit errors in the received downstream FS frames as measured
66// using BIP-32. If FEC is supported in the downstream direction, the BIP-32 count applies to the
67// downstream FS frame after the FEC correction has been applied and the FEC parity bytes have been
68// removed. (R) (mandatory) (4-bytes)
69//
70// Corrected Psbd Hec Error Count
71// Corrected PSBd HEC error count: The count of the errors in either CFC or OCS fields of the PSBd
72// block that have been corrected using the HEC technique. (R) (mandatory) (4-bytes)
73//
74// Uncorrectable Psbd Hec Error Count
75// Uncorrectable PSBd HEC error count: The count of the errors in either CFC or OCS fields of the
76// PSBd block that could not be corrected using the HEC technique. (R) (mandatory) (4-bytes)
77//
78// Corrected Downstream Fs Header Hec Error Count
79// Corrected downstream FS header HEC error count: The count of the errors in the downstream FS
80// header that have been corrected using the HEC technique. (R) (mandatory) (4-bytes)
81//
82// Uncorrectable Downstream Fs Header Hec Error Count
83// Uncorrectable downstream FS header HEC error count: The count of the errors in the downstream FS
84// header that could not be corrected using the HEC technique. (R) (mandatory) (4-bytes)
85//
86// Total Number Of Lods Events
87// Total number of LODS events: The count of the state transitions from O5.1/O5.2 to O6, referring
88// to the ONU activation cycle state machine, clause 12 of [ITU-T-G.989.3]. (R) (mandatory)
89// (4-bytes)
90//
91// Lods Events Restored In Operating Twdm Channel
92// LODS events restored in operating TWDM channel: The count of LODS events cleared automatically
93// without retuning. (R) (mandatory) (4-bytes)
94//
95// Lods Events Restored In Protection Twdm Channel
96// LODS events restored in protection TWDM channel: The count of LODS events resolved by retuning
97// to a pre-configured protection TWDM channel. The event is counted against the original operating
98// channel. (R) (mandatory) (4-bytes)
99//
100// Lods Events Restored In Discretionary Twdm Channel
101// LODS events restored in discretionary TWDM channel: The count of LODS events resolved by
102// retuning to a TWDM channel chosen by the ONU, without retuning. Implies that the wavelength
103// channel protection for the operating channel is not active. The event is counted against the
104// original operating channel (R) (mandatory) (4-bytes)
105//
106// Lods Events Resulting In Reactivation
107// LODS events resulting in reactivation: The count of LODS events resolved through ONU
108// reactivation; that is, either TO2 (without WLCP) or TO3-+ TO4 (with WLCP) expires before the
109// downstream channel is reacquired, referring to the ONU activation cycle state machine, clause 12
110// of [ITU-T-G.989.3]. The event is counted against the original operating channel (R) (mandatory)
111// (4-bytes)
112//
113// Lods Events Resulting In Reactivation After Retuning To Protection Twdm Channel
114// LODS events resulting in reactivation after retuning to protection TWDM channel: The count of
115// LODS events resolved through ONU reactivation after attempted protection switching, which turns
116// unsuccessful due to a handshake failure. (R) (mandatory) (4-bytes)
117//
118// Lods Events Resulting In Reactivation After Retuning To Discretionary Twdm Channel
119// LODS events resulting in reactivation after retuning to discretionary TWDM channel: The count of
120// LODS events resolved through ONU reactivation after attempted retuning to a discretionary
121// channel, which turns unsuccessful due to a handshake failure. (R) (mandatory) (4-bytes)
122//
123type TwdmChannelPhyLodsPerformanceMonitoringHistoryData struct {
124 ManagedEntityDefinition
125 Attributes AttributeValueMap
126}
127
128func init() {
129 twdmchannelphylodsperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
130 Name: "TwdmChannelPhyLodsPerformanceMonitoringHistoryData",
131 ClassID: 444,
132 MessageTypes: mapset.NewSetWith(
133 Create,
134 Delete,
135 Get,
136 GetCurrentData,
137 Set,
138 ),
139 AllowedAttributeMask: 0xfffe,
140 AttributeDefinitions: AttributeDefinitionMap{
141 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
142 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
143 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
144 3: Uint64Field("TotalReceivedWordsProtectedByBitInterleavedParity32Bip32", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
145 4: Uint32Field("Bip32BitErrorCount", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
146 5: Uint32Field("CorrectedPsbdHecErrorCount", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
147 6: Uint32Field("UncorrectablePsbdHecErrorCount", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
148 7: Uint32Field("CorrectedDownstreamFsHeaderHecErrorCount", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
149 8: Uint32Field("UncorrectableDownstreamFsHeaderHecErrorCount", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
150 9: Uint32Field("TotalNumberOfLodsEvents", CounterAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
151 10: Uint32Field("LodsEventsRestoredInOperatingTwdmChannel", CounterAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
152 11: Uint32Field("LodsEventsRestoredInProtectionTwdmChannel", CounterAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, false, false, 11),
153 12: Uint32Field("LodsEventsRestoredInDiscretionaryTwdmChannel", CounterAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, false, false, 12),
154 13: Uint32Field("LodsEventsResultingInReactivation", CounterAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13),
155 14: Uint32Field("LodsEventsResultingInReactivationAfterRetuningToProtectionTwdmChannel", CounterAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14),
156 15: Uint32Field("LodsEventsResultingInReactivationAfterRetuningToDiscretionaryTwdmChannel", CounterAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, false, false, 15),
157 },
158 Access: CreatedByOlt,
159 Support: UnknownSupport,
160 }
161}
162
163// NewTwdmChannelPhyLodsPerformanceMonitoringHistoryData (class ID 444) creates the basic
164// Managed Entity definition that is used to validate an ME of this type that
165// is received from or transmitted to the OMCC.
166func NewTwdmChannelPhyLodsPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
167 return NewManagedEntity(*twdmchannelphylodsperformancemonitoringhistorydataBME, params...)
168}