blob: 02c8755202dd48b6ae1d8d6bac8d81e5def02bec [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// TwdmChannelTuningPerformanceMonitoringHistoryDataPart1ClassID is the 16-bit ID for the OMCI
29// Managed entity TWDM channel tuning performance monitoring history data part 1
30const TwdmChannelTuningPerformanceMonitoringHistoryDataPart1ClassID ClassID = ClassID(449)
31
32var twdmchanneltuningperformancemonitoringhistorydatapart1BME *ManagedEntityDefinition
33
34// TwdmChannelTuningPerformanceMonitoringHistoryDataPart1 (class ID #449)
35// 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
51// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
52// identical ID, this ME is implicitly linked to an instance of the TWDM channel ME. (R,
53// setbycreate) (mandatory) (2-bytes)
54//
55// Interval End Time
56// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
57// (mandatory) (1-byte)
58//
59// Threshold Data 1_2 Id
60// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
61// that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)
62//
63// Tuning Control Requests For Rx Only Or Rx And Tx
64// Tuning control requests for Rx only or Rx and Tx: The counter of received Tuning_Control PLOAM
65// messages with Request operation code that contain tuning instructions either for receiver only
66// or for both receiver and transmitter. (R) (mandatory) (4-byte)
67//
68// Tuning Control Requests For Tx Only
69// Tuning control requests for Tx only: The counter of received Tuning_Control PLOAM messages with
70// Request operation code that contain tuning instructions for transmitter only. (R) (mandatory)
71// (4-byte)
72//
73// Tuning Control Requests Rejected_Int_Sfc
74// Tuning control requests rejected/INT_SFC: The counter of transmitted Tuning_Response PLOAM
75// messages with NACK operation code and INT_SFC response code, indicating inability to start
76// transceiver tuning by the specified time (SFC). (R) (mandatory) (4-byte)
77//
78// Tuning Control Requests Rejected_Ds_Xxx
79// Tuning control requests rejected/DS_xxx: The aggregate counter of transmitted Tuning_Response
80// PLOAM messages with NACK operation code and any DS_xxx response code, indicating target
81// downstream wavelength channel inconsistency. (R) (mandatory) (4-byte)
82//
83// Tuning Control Requests Rejected_Us_Xxx
84// Tuning control requests rejected/US_xxx: The aggregate counter of transmitted Tuning_Response
85// PLOAM messages with NACK operation code and any US_xxx response code, indicating target upstream
86// wavelength channel inconsistency. (R) (mandatory) (4-byte)
87//
88// Tuning Control Requests Fulfilled With Onu Reacquired At Target Channel
89// Tuning control requests fulfilled with ONU reacquired at target channel: The counter of
90// controlled tuning attempts for which an upstream tuning confirmation has been obtained in the
91// target channel. (R) (mandatory) (4-byte)
92//
93// Tuning Control Requests Failed Due To Target Ds Wavelength Channel Not Found
94// Tuning control requests failed due to target DS wavelength channel not found: The counter of
95// controlled tuning attempts that failed due to timer TO4 expiration in the DS Tuning state (O8)
96// in the target channel. (R) (mandatory) (4-byte)
97//
98// Tuning Control Requests Failed Due To No Feedback In Target Ds Wavelength Channel
99// Tuning control requests failed due to no feedback in target DS wavelength channel: The counter
100// of controlled tuning attempts that failed due to timer TO5 expiration in the US Tuning state
101// (O9) in the target channel. (R) (mandatory) (4-byte)
102//
103// Tuning Control Requests Resolved With Onu Reacquired At Discretionary Channel
104// Tuning control requests resolved with ONU reacquired at discretionary channel: The counter of
105// controlled tuning attempts for which an upstream tuning confirmation has been obtained in the
106// discretionary channel. (R) (mandatory) (4-byte)
107//
108// Tuning Control Requests Rollback_Com_Ds
109// Tuning control requests Rollback/COM_DS: The counter of controlled tuning attempts that failed
110// due to communication condition in the target channel, as indicated by the Tuning_Response PLOAM
111// message with Rollback operation code and COM_DS response code. (R) (mandatory) (4-byte)
112//
113// Tuning Control Requests Rollback_Ds_Xxx
114// Tuning control requests Rollback/DS_xxx: The aggregate counter of controlled tuning attempts
115// that failed due to target downstream wavelength channel inconsistency, as indicated by the
116// Tuning_Response PLOAM message with Rollback operation code and any DS_xxx response code. (R)
117// (mandatory) (4-byte)
118//
119// Tuning Control Requests Rollback_Us_Xxx
120// Tuning control requests Rollback/US_xxx: The aggregate counter of controlled tuning attempts
121// that failed due to target upstream wavelength channel parameter violation, as indicated by the
122// Tuning_Response PLOAM message with Rollback operation code and US_xxx response code. (R)
123// (mandatory) (4-byte)
124//
125// Tuning Control Requests Failed With Onu Reactivation
126// Tuning control requests failed with ONU reactivation: The counter of controlled tuning attempts
127// that failed on any reason, with expiration of timers TO4 or TO5 causing the ONU transition into
128// state O1. (R) (mandatory) (4-byte)
129//
130type TwdmChannelTuningPerformanceMonitoringHistoryDataPart1 struct {
131 ManagedEntityDefinition
132 Attributes AttributeValueMap
133}
134
135func init() {
136 twdmchanneltuningperformancemonitoringhistorydatapart1BME = &ManagedEntityDefinition{
137 Name: "TwdmChannelTuningPerformanceMonitoringHistoryDataPart1",
138 ClassID: 449,
139 MessageTypes: mapset.NewSetWith(
140 Create,
141 Delete,
142 Get,
143 Set,
144 ),
145 AllowedAttributeMask: 0xfffe,
146 AttributeDefinitions: AttributeDefinitionMap{
147 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
148 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
149 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
150 3: Uint32Field("TuningControlRequestsForRxOnlyOrRxAndTx", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
151 4: Uint32Field("TuningControlRequestsForTxOnly", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
152 5: Uint32Field("TuningControlRequestsRejectedIntSfc", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
153 6: Uint32Field("TuningControlRequestsRejectedDsXxx", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
154 7: Uint32Field("TuningControlRequestsRejectedUsXxx", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
155 8: Uint32Field("TuningControlRequestsFulfilledWithOnuReacquiredAtTargetChannel", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
156 9: Uint32Field("TuningControlRequestsFailedDueToTargetDsWavelengthChannelNotFound", CounterAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
157 10: Uint32Field("TuningControlRequestsFailedDueToNoFeedbackInTargetDsWavelengthChannel", CounterAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
158 11: Uint32Field("TuningControlRequestsResolvedWithOnuReacquiredAtDiscretionaryChannel", CounterAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, false, false, 11),
159 12: Uint32Field("TuningControlRequestsRollbackComDs", CounterAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, false, false, 12),
160 13: Uint32Field("TuningControlRequestsRollbackDsXxx", CounterAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13),
161 14: Uint32Field("TuningControlRequestsRollbackUsXxx", CounterAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14),
162 15: Uint32Field("TuningControlRequestsFailedWithOnuReactivation", CounterAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, false, false, 15),
163 },
164 Access: CreatedByOlt,
165 Support: UnknownSupport,
166 }
167}
168
169// NewTwdmChannelTuningPerformanceMonitoringHistoryDataPart1 (class ID 449) creates the basic
170// Managed Entity definition that is used to validate an ME of this type that
171// is received from or transmitted to the OMCC.
172func NewTwdmChannelTuningPerformanceMonitoringHistoryDataPart1(params ...ParamData) (*ManagedEntity, OmciErrors) {
173 return NewManagedEntity(*twdmchanneltuningperformancemonitoringhistorydatapart1BME, params...)
174}