blob: c4f3acade899ad26dbee04cff2408a7f421f4105 [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// XdslLineInventoryAndStatusDataPart5ClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL line inventory and status data part 5
30const XdslLineInventoryAndStatusDataPart5ClassID ClassID = ClassID(325)
31
32var xdsllineinventoryandstatusdatapart5BME *ManagedEntityDefinition
33
34// XdslLineInventoryAndStatusDataPart5 (class ID #325)
35// This ME extends the attributes defined in the xDSL line inventory and status data parts 1..4.
36// This ME reports FEXT and NEXT attributes, and pertains to Annex C of [ITUT G.992.3] (ADSL2) and
37// Annex C of [ITUT G.992.5] (ADSL2plus).
38//
39// Relationships
40// This is one of the status data MEs associated with an xDSL UNI. The ONU automatically creates or
41// deletes an instance of this ME upon creation or deletion of a PPTP xDSL UNI part 1 that supports
42// these attributes.
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 PPTP xDSL UNI part 1 ME. (R)
48// (mandatory) (2-bytes)
49//
50// Fext Downstream Snr Margin
51// FEXT downstream SNR margin: The FEXT SNRMds attribute is the downstream SNR margin measured
52// during FEXTR duration at the ATU-R. The attribute value ranges from 0 (-64.0-dB) to 1270
53// (+63.0-dB). The special value 0xFFFF indicates that the attribute is out of range. (R)
54// (mandatory) (2-bytes)
55//
56// Next Downstream Snr Margin
57// NEXT downstream SNR margin: The NEXT SNRMds attribute is the downstream SNR margin measured
58// during NEXTR duration at the ATU-R. The attribute value ranges from 0 (-64.0-dB) to 1270
59// (+63.0-dB). The special value 0xFFFF indicates that the attribute is out of range. (R)
60// (mandatory) (2-bytes)
61//
62// Fext Upstream Snr Margin
63// FEXT upstream SNR margin: The FEXT SNRMus attribute is the upstream SNR margin (see clause
64// 7.5.1.16 of [ITUT G.997.1]) measured during FEXTC duration at the ATU-C. The attribute value
65// ranges from 0 (-64.0-dB) to 1270 (+63.0-dB). The special value 0xFFFF indicates that the
66// attribute is out of range. (R) (mandatory) (2-bytes)
67//
68// Next Upstream Snr Margin
69// NEXT upstream SNR margin: The NEXT SNRMus attribute is the upstream SNR margin (see clause
70// 7.5.1.16 of [ITUT-G.997.1]) measured during NEXTC duration at the ATU-C. The attribute value
71// ranges from 0 (-64.0-dB) to 1270 (+63.0-dB). The special value 0xFFFF indicates that the
72// attribute is out of range. (R) (mandatory) (2-bytes)
73//
74// Fext Downstream Maximum Attainable Data Rate
75// FEXT downstream maximum attainable data rate: The FEXT ATTNDRds attribute is the maximum
76// downstream net data rate calculated from FEXT downstream SNR(f) (see clause 7.5.1.28.3.1 of
77// [ITUT G.997.1]). The rate is coded in bits per second. (R) (mandatory) (4-bytes)
78//
79// Next Downstream Maximum Attainable Data Rate
80// NEXT downstream maximum attainable data rate: The NEXT ATTNDRds attribute is the maximum
81// downstream net data rate calculated from NEXT downstream SNR(f) (see clause 7.5.1.28.3.2 of
82// [ITUT G.997.1]). The rate is coded in bits per second. (R) (mandatory) (4-bytes)
83//
84// Fext Upstream Maximum Attainable Data Rate
85// FEXT upstream maximum attainable data rate: The FEXT ATTNDRus attribute is the maximum upstream
86// net data rate calculated from FEXT upstream SNR(f) (see clause 7.5.1.28.6.1 of [ITUT G.997.1]).
87// The rate is coded in bits per second. (R) (mandatory) (4-bytes)
88//
89// Next Upstream Maximum Attainable Data Rate
90// NEXT upstream maximum attainable data rate: The NEXT ATTNDRus attribute is the maximum upstream
91// net data rate calculated from NEXT upstream SNR(f) (see clause 7.5.1.28.6.2 of [ITUT G.997.1]).
92// The rate is coded in bits per second. (R) (mandatory) (4-bytes)
93//
94// Fext Downstream Actual Power Spectral Density
95// FEXT downstream actual power spectral density: The FEXT ACTPSDds attribute is the average
96// downstream transmit PSD over the used subcarriers (see clause-7.5.1.21.1 of [ITUT G.997.1])
97// calculated from the REFPSDds and RMSGIds for FEXTR duration. The attribute value ranges from 0
98// (-90.0-dBm/Hz) to 900 (0.0-dBm/Hz). The special value 0xFFFF indicates that the parameter is out
99// of range. (R) (mandatory) (2-bytes)
100//
101// Next Downstream Actual Power Spectral Density
102// NEXT downstream actual power spectral density: The NEXT ACTPSDds attribute is the average
103// downstream transmit PSD over the used subcarriers (see clause-7.5.1.21.2 of [ITUT G.997.1])
104// calculated from the REFPSDds and RMSGIds for NEXTR duration. The attribute value ranges from 0
105// (-90.0-dBm/Hz) to 900 (0.0-dBm/Hz). The special value 0xFFFF indicates that the parameter is out
106// of range. (R) (mandatory) (2-bytes)
107//
108// Fext Upstream Actual Power Spectral Density
109// FEXT upstream actual power spectral density: The FEXT ACTPSDus attribute is the average upstream
110// transmit PSD over the used subcarriers (see clause-7.5.1.22.1 of [ITUT G.997.1]) calculated from
111// the REFPSDus and RMSGIus for FEXTC duration. The attribute value ranges from 0 (-90.0-dBm/Hz) to
112// 900 (0.0-dBm/Hz). The special value 0xFFFF indicates that the parameter is out of range. (R)
113// (mandatory) (2-bytes)
114//
115// Next Upstream Actual Power Spectral Density
116// NEXT upstream actual power spectral density: The NEXT ACTPSDus attribute is the average upstream
117// transmit PSD over the used subcarriers (see clause-7.5.1.22.2 of [ITUT G.997.1]) calculated from
118// the REFPSDus and RMSGIus for NEXTC duration. The attribute value ranges from 0 (-90.0-dBm/Hz) to
119// 900 (0.0-dBm/Hz). The special value 0xFFFF indicates that the parameter is out of range. (R)
120// (mandatory) (2-bytes)
121//
122// Fext Downstream Actual Aggregate Transmit Power
123// FEXT downstream actual aggregate transmit power: The FEXT ACTATPds attribute is the total amount
124// of transmit power (see clause 7.5.1.24.1 of [ITUT G.997.1]) calculated from PSDds measured
125// during FEXTR duration at the ATU-R. The attribute value ranges from 0 (-31.0-dBm) to 620
126// (+31.0-dBm). The special value 0xFFFF indicates that the parameter is out of range. (R)
127// (mandatory) (2-bytes)
128//
129// Next Downstream Actual Aggregate Transmit Power
130// NEXT downstream actual aggregate transmit power: The NEXT ACTATPds attribute is the total amount
131// of transmit power (see clause 7.5.1.24.2 of [ITUT G.997.1]) calculated from PSDds measured
132// during NEXTR duration at the ATU-R. The attribute value ranges from 0 (-31.0-dBm) to 620
133// (+31.0-dBm). The special value 0xFFFF indicates that the parameter is out of range. (R)
134// (mandatory) (2-bytes)
135//
136// Fext Upstream Actual Aggregate Transmit Power
137// FEXT upstream actual aggregate transmit power: The FEXT ACTATPus attribute is the total transmit
138// power (see clause 7.5.1.25.1 of [ITUT G.997.1]) calculated from PSDus measured during FEXTC
139// duration at the ATU-C. The attribute value ranges from 0 (-31.0-dBm) to 620 (+31.0-dBm). The
140// special value 0xFFFF indicates that the parameter is out of range. (R) (mandatory) (2-bytes)
141//
142// Next Upstream Actual Aggregate Transmit Power
143// NEXT upstream actual aggregate transmit power: The NEXT ACTATPus attribute is the total transmit
144// power (see clause 7.5.1.25.2 of [ITUT G.997.1]) calculated from PSDus measured during NEXTC
145// duration at the ATU-C. The attribute value ranges from 0 (-31.0-dBm) to 620 (+31.0-dBm). The
146// special value 0xFFFF indicates that the parameter is out of range. (R) (mandatory) (2-bytes)
147//
148type XdslLineInventoryAndStatusDataPart5 struct {
149 ManagedEntityDefinition
150 Attributes AttributeValueMap
151}
152
153func init() {
154 xdsllineinventoryandstatusdatapart5BME = &ManagedEntityDefinition{
155 Name: "XdslLineInventoryAndStatusDataPart5",
156 ClassID: 325,
157 MessageTypes: mapset.NewSetWith(
158 Get,
159 ),
160 AllowedAttributeMask: 0xffff,
161 AttributeDefinitions: AttributeDefinitionMap{
162 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
163 1: Uint16Field("FextDownstreamSnrMargin", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
164 2: Uint16Field("NextDownstreamSnrMargin", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, false, false, 2),
165 3: Uint16Field("FextUpstreamSnrMargin", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
166 4: Uint16Field("NextUpstreamSnrMargin", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
167 5: Uint32Field("FextDownstreamMaximumAttainableDataRate", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
168 6: Uint32Field("NextDownstreamMaximumAttainableDataRate", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
169 7: Uint32Field("FextUpstreamMaximumAttainableDataRate", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
170 8: Uint32Field("NextUpstreamMaximumAttainableDataRate", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
171 9: Uint16Field("FextDownstreamActualPowerSpectralDensity", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
172 10: Uint16Field("NextDownstreamActualPowerSpectralDensity", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
173 11: Uint16Field("FextUpstreamActualPowerSpectralDensity", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, false, false, 11),
174 12: Uint16Field("NextUpstreamActualPowerSpectralDensity", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, false, false, 12),
175 13: Uint16Field("FextDownstreamActualAggregateTransmitPower", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13),
176 14: Uint16Field("NextDownstreamActualAggregateTransmitPower", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14),
177 15: Uint16Field("FextUpstreamActualAggregateTransmitPower", UnsignedIntegerAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, false, false, 15),
178 16: Uint16Field("NextUpstreamActualAggregateTransmitPower", UnsignedIntegerAttributeType, 0x0001, 0, mapset.NewSetWith(Read), false, false, false, 16),
179 },
180 Access: CreatedByOnu,
181 Support: UnknownSupport,
182 }
183}
184
185// NewXdslLineInventoryAndStatusDataPart5 (class ID 325) creates the basic
186// Managed Entity definition that is used to validate an ME of this type that
187// is received from or transmitted to the OMCC.
188func NewXdslLineInventoryAndStatusDataPart5(params ...ParamData) (*ManagedEntity, OmciErrors) {
189 return NewManagedEntity(*xdsllineinventoryandstatusdatapart5BME, params...)
190}