blob: bc14a281b371fcf4040fcd4e5b6789eddeb0267a [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 */
David K. Bainbridgeadf422d2021-04-09 16:06:41 +000017/*
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// TwdmChannelTuningPerformanceMonitoringHistoryDataPart1ClassID is the 16-bit ID for the OMCI
29// Managed entity TWDM channel tuning performance monitoring history data part 1
Chip Boling610117d2021-09-09 11:24:34 -050030const TwdmChannelTuningPerformanceMonitoringHistoryDataPart1ClassID = ClassID(449) // 0x01c1
Chip Boling6e27b352020-02-14 09:10:01 -060031
32var twdmchanneltuningperformancemonitoringhistorydatapart1BME *ManagedEntityDefinition
33
Chip Boling610117d2021-09-09 11:24:34 -050034// TwdmChannelTuningPerformanceMonitoringHistoryDataPart1 (Class ID: #449 / 0x01c1)
Chip Boling6e27b352020-02-14 09:10:01 -060035// This ME collects certain tuning-control-related PM data associated with the slot/circuit pack,
36// hosting one or more ANI-G MEs, for a specific TWDM channel. Instances of this ME are created and
37// deleted by the OLT.
38//
39// The relevant events this ME is concerned with are counted towards the PM statistics associated
40// with the source TWDM channel. The attribute descriptions refer to the ONU activation cycle
41// states and timers specified in clause 12 of [ITU-T- G.989.3]. This ME contains the counters
42// characterized as mandatory in clause 14 of [ITU-T- G.989.3].
43//
44// For a complete discussion of generic PM architecture, refer to clause I.4.
45//
46// Relationships
47// An instance of this ME is associated with an instance of TWDM channel ME.
48//
49// Attributes
50// Managed Entity Id
Chip Boling610117d2021-09-09 11:24:34 -050051// This attribute uniquely identifies each instance of this ME. Through an identical ID, this ME is
52// implicitly linked to an instance of the TWDM channel ME. (R, setbycreate) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060053//
54// Interval End Time
Chip Boling610117d2021-09-09 11:24:34 -050055// This attribute identifies the most recently finished 15-min interval. (R) (mandatory) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060056//
57// Threshold Data 1_2 Id
58// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
59// that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)
60//
61// Tuning Control Requests For Rx Only Or Rx And Tx
Chip Boling610117d2021-09-09 11:24:34 -050062// The counter of received Tuning_Control PLOAM messages with Request operation code that contain
63// tuning instructions either for receiver only or for both receiver and transmitter. (R)
64// (mandatory) (4-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060065//
66// Tuning Control Requests For Tx Only
Chip Boling610117d2021-09-09 11:24:34 -050067// The counter of received Tuning_Control PLOAM messages with Request operation code that contain
68// tuning instructions for transmitter only. (R) (mandatory) (4-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060069//
70// Tuning Control Requests Rejected_Int_Sfc
71// Tuning control requests rejected/INT_SFC: The counter of transmitted Tuning_Response PLOAM
72// messages with NACK operation code and INT_SFC response code, indicating inability to start
73// transceiver tuning by the specified time (SFC). (R) (mandatory) (4-byte)
74//
75// Tuning Control Requests Rejected_Ds_Xxx
76// Tuning control requests rejected/DS_xxx: The aggregate counter of transmitted Tuning_Response
77// PLOAM messages with NACK operation code and any DS_xxx response code, indicating target
78// downstream wavelength channel inconsistency. (R) (mandatory) (4-byte)
79//
80// Tuning Control Requests Rejected_Us_Xxx
81// Tuning control requests rejected/US_xxx: The aggregate counter of transmitted Tuning_Response
82// PLOAM messages with NACK operation code and any US_xxx response code, indicating target upstream
83// wavelength channel inconsistency. (R) (mandatory) (4-byte)
84//
85// Tuning Control Requests Fulfilled With Onu Reacquired At Target Channel
Chip Boling610117d2021-09-09 11:24:34 -050086// The counter of controlled tuning attempts for which an upstream tuning confirmation has been
87// obtained in the target channel. (R) (mandatory) (4-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060088//
89// Tuning Control Requests Failed Due To Target Ds Wavelength Channel Not Found
Chip Boling610117d2021-09-09 11:24:34 -050090// The counter of controlled tuning attempts that failed due to timer TO4 expiration in the DS
91// Tuning state (O8) in the target channel. (R) (mandatory) (4-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060092//
93// Tuning Control Requests Failed Due To No Feedback In Target Ds Wavelength Channel
Chip Boling610117d2021-09-09 11:24:34 -050094// The counter of controlled tuning attempts that failed due to timer TO5 expiration in the US
95// Tuning state (O9) in the target channel. (R) (mandatory) (4-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060096//
97// Tuning Control Requests Resolved With Onu Reacquired At Discretionary Channel
Chip Boling610117d2021-09-09 11:24:34 -050098// The counter of controlled tuning attempts for which an upstream tuning confirmation has been
99// obtained in the discretionary channel. (R) (mandatory) (4-byte)
Chip Boling6e27b352020-02-14 09:10:01 -0600100//
101// Tuning Control Requests Rollback_Com_Ds
102// Tuning control requests Rollback/COM_DS: The counter of controlled tuning attempts that failed
103// due to communication condition in the target channel, as indicated by the Tuning_Response PLOAM
104// message with Rollback operation code and COM_DS response code. (R) (mandatory) (4-byte)
105//
106// Tuning Control Requests Rollback_Ds_Xxx
107// Tuning control requests Rollback/DS_xxx: The aggregate counter of controlled tuning attempts
108// that failed due to target downstream wavelength channel inconsistency, as indicated by the
109// Tuning_Response PLOAM message with Rollback operation code and any DS_xxx response code. (R)
110// (mandatory) (4-byte)
111//
112// Tuning Control Requests Rollback_Us_Xxx
113// Tuning control requests Rollback/US_xxx: The aggregate counter of controlled tuning attempts
114// that failed due to target upstream wavelength channel parameter violation, as indicated by the
115// Tuning_Response PLOAM message with Rollback operation code and US_xxx response code. (R)
116// (mandatory) (4-byte)
117//
118// Tuning Control Requests Failed With Onu Reactivation
Chip Boling610117d2021-09-09 11:24:34 -0500119// The counter of controlled tuning attempts that failed on any reason, with expiration of timers
120// TO4 or TO5 causing the ONU transition into state O1. (R) (mandatory) (4-byte)
Chip Boling6e27b352020-02-14 09:10:01 -0600121//
122type TwdmChannelTuningPerformanceMonitoringHistoryDataPart1 struct {
123 ManagedEntityDefinition
124 Attributes AttributeValueMap
125}
126
127func init() {
128 twdmchanneltuningperformancemonitoringhistorydatapart1BME = &ManagedEntityDefinition{
129 Name: "TwdmChannelTuningPerformanceMonitoringHistoryDataPart1",
130 ClassID: 449,
131 MessageTypes: mapset.NewSetWith(
132 Create,
133 Delete,
134 Get,
135 Set,
136 ),
137 AllowedAttributeMask: 0xfffe,
138 AttributeDefinitions: AttributeDefinitionMap{
139 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
140 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
141 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
142 3: Uint32Field("TuningControlRequestsForRxOnlyOrRxAndTx", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
143 4: Uint32Field("TuningControlRequestsForTxOnly", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
144 5: Uint32Field("TuningControlRequestsRejectedIntSfc", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
145 6: Uint32Field("TuningControlRequestsRejectedDsXxx", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
146 7: Uint32Field("TuningControlRequestsRejectedUsXxx", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
147 8: Uint32Field("TuningControlRequestsFulfilledWithOnuReacquiredAtTargetChannel", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
148 9: Uint32Field("TuningControlRequestsFailedDueToTargetDsWavelengthChannelNotFound", CounterAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
149 10: Uint32Field("TuningControlRequestsFailedDueToNoFeedbackInTargetDsWavelengthChannel", CounterAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
150 11: Uint32Field("TuningControlRequestsResolvedWithOnuReacquiredAtDiscretionaryChannel", CounterAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, false, false, 11),
151 12: Uint32Field("TuningControlRequestsRollbackComDs", CounterAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, false, false, 12),
152 13: Uint32Field("TuningControlRequestsRollbackDsXxx", CounterAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13),
153 14: Uint32Field("TuningControlRequestsRollbackUsXxx", CounterAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14),
154 15: Uint32Field("TuningControlRequestsFailedWithOnuReactivation", CounterAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, false, false, 15),
155 },
156 Access: CreatedByOlt,
157 Support: UnknownSupport,
158 }
159}
160
161// NewTwdmChannelTuningPerformanceMonitoringHistoryDataPart1 (class ID 449) creates the basic
162// Managed Entity definition that is used to validate an ME of this type that
163// is received from or transmitted to the OMCC.
164func NewTwdmChannelTuningPerformanceMonitoringHistoryDataPart1(params ...ParamData) (*ManagedEntity, OmciErrors) {
165 return NewManagedEntity(*twdmchanneltuningperformancemonitoringhistorydatapart1BME, params...)
166}