blob: 2633fc5d845e3f2550c593b9fdd52ea3a21823f9 [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// TwdmChannelPloamPerformanceMonitoringHistoryDataPart1ClassID is the 16-bit ID for the OMCI
29// Managed entity TWDM channel PLOAM performance monitoring history data part 1
30const TwdmChannelPloamPerformanceMonitoringHistoryDataPart1ClassID ClassID = ClassID(446)
31
32var twdmchannelploamperformancemonitoringhistorydatapart1BME *ManagedEntityDefinition
33
34// TwdmChannelPloamPerformanceMonitoringHistoryDataPart1 (class ID #446)
35// This ME collects certain PLOAM-related PM data associated with the slot/circuit pack, hosting
36// one or more ANI-G MEs, for a specific TWDM channel. Instances of this ME are created and deleted
37// by the OLT.
38//
39// The downstream PLOAM message counts of this ME include only the received PLOAM messages
40// pertaining to the given ONU, i.e.:
41//
42// - unicast PLOAM messages, addressed by ONU-ID;
43//
44// - broadcast PLOAM messages, addressed by serial number;
45//
46// - broadcast PLOAM messages, addressed to all ONUs on the PON.
47//
48// This ME includes all PLOAM PM counters characterized as mandatory in clause 14 of [ITU-
49// T-G.989.3].
50//
51// For a complete discussion of generic PM architecture, refer to clause I.4.
52//
53// Relationships
54// An instance of this ME is associated with an instance of TWDM channel ME.
55//
56// Attributes
57// Managed Entity Id
58// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
59// identical ID, this ME is implicitly linked to an instance of the TWDM channel ME. (R,
60// setbycreate) (mandatory) (2-bytes)
61//
62// Interval End Time
63// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
64// (mandatory) (1-byte)
65//
66// Threshold Data 1_2 Id
67// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
68// that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)
69//
70// Ploam Mic Errors
71// PLOAM MIC errors: The counter of received PLOAM messages that remain unparsable due to MIC
72// error. (R) (mandatory) (4-byte)
73//
74// Downstream Ploam Message Count
75// Downstream PLOAM message count: The counter of received broadcast and unicast PLOAM messages
76// pertaining to the given ONU. (R) (mandatory) (4-byte)
77//
78// Ranging_Time Message Count
79// Ranging_Time message count: The counter of received Ranging_Time PLOAM messages. (R) (mandatory)
80// (4-byte)
81//
82// Protection_Control Message Count
83// Protection_Control message count: The counter of received Protection_Control PLOAM messages. (R)
84// (mandatory) (4-byte)
85//
86// Adjust_Tx_Wavelength Message Count
87// Adjust_Tx_Wavelength message count: The counter of received Adjust_Tx_Wavelength PLOAM messages.
88// (R) (mandatory) (4-byte)
89//
90// Adjust_Tx_Wavelength Adjustment Amplitude
91// Adjust_Tx_Wavelength adjustment amplitude: An estimator of the absolute value of the
92// transmission wavelength adjustment. (R) (mandatory) (4-byte)
93//
94type TwdmChannelPloamPerformanceMonitoringHistoryDataPart1 struct {
95 ManagedEntityDefinition
96 Attributes AttributeValueMap
97}
98
99func init() {
100 twdmchannelploamperformancemonitoringhistorydatapart1BME = &ManagedEntityDefinition{
101 Name: "TwdmChannelPloamPerformanceMonitoringHistoryDataPart1",
102 ClassID: 446,
103 MessageTypes: mapset.NewSetWith(
104 Create,
105 Delete,
106 Get,
107 GetCurrentData,
108 Set,
109 ),
110 AllowedAttributeMask: 0xff00,
111 AttributeDefinitions: AttributeDefinitionMap{
112 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
113 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
114 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
115 3: Uint32Field("PloamMicErrors", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
116 4: Uint32Field("DownstreamPloamMessageCount", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
117 5: Uint32Field("RangingTimeMessageCount", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
118 6: Uint32Field("ProtectionControlMessageCount", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
119 7: Uint32Field("AdjustTxWavelengthMessageCount", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
120 8: Uint32Field("AdjustTxWavelengthAdjustmentAmplitude", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
121 },
122 Access: CreatedByOlt,
123 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600124 Alarms: AlarmMap{
125 0: "PLOAM MIC errors",
126 },
Chip Boling6e27b352020-02-14 09:10:01 -0600127 }
128}
129
130// NewTwdmChannelPloamPerformanceMonitoringHistoryDataPart1 (class ID 446) creates the basic
131// Managed Entity definition that is used to validate an ME of this type that
132// is received from or transmitted to the OMCC.
133func NewTwdmChannelPloamPerformanceMonitoringHistoryDataPart1(params ...ParamData) (*ManagedEntity, OmciErrors) {
134 return NewManagedEntity(*twdmchannelploamperformancemonitoringhistorydatapart1BME, params...)
135}