blob: 037d7b087c7ac9ff88578c1fc331ed4c3960b73a [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
Chip Boling8cdd6392022-01-27 08:43:37 -06004 *
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
Chip Boling8cdd6392022-01-27 08:43:37 -06008 *
Chip Boling6e27b352020-02-14 09:10:01 -06009 * http://www.apache.org/licenses/LICENSE-2.0
Chip Boling8cdd6392022-01-27 08:43:37 -060010 *
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// XdslSubcarrierMaskingUpstreamProfileClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL subcarrier masking upstream profile
Chip Boling610117d2021-09-09 11:24:34 -050030const XdslSubcarrierMaskingUpstreamProfileClassID = ClassID(109) // 0x006d
Chip Boling6e27b352020-02-14 09:10:01 -060031
32var xdslsubcarriermaskingupstreamprofileBME *ManagedEntityDefinition
33
Chip Boling610117d2021-09-09 11:24:34 -050034// XdslSubcarrierMaskingUpstreamProfile (Class ID: #109 / 0x006d)
Chip Boling6e27b352020-02-14 09:10:01 -060035// This ME contains the subcarrier masking upstream profile for an xDSL UNI. An instance of this ME
36// is created and deleted by the OLT.
37//
38// Relationships
39// An instance of this ME may be associated with zero or more instances of the PPTP xDSL UNI part
40// 1.
41//
42// Attributes
43// Managed Entity Id
Chip Boling610117d2021-09-09 11:24:34 -050044// This attribute uniquely identifies each instance of this ME. The value 0 is reserved. (R,
45// setbycreate) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060046//
47// Upstream Subcarrier Mask
Chip Boling610117d2021-09-09 11:24:34 -050048// This attribute is a bit map representing upstream mask values for subcarriers 1 to 64. The MSB
49// of byte 1 corresponds to subcarrier 1, and the LSB of byte 8 corresponds to subcarrier 64. Each
50// bit position defines whether the corresponding downstream subcarrier is masked (1) or not masked
51// (0).
52//
Chip Boling6e27b352020-02-14 09:10:01 -060053// Subcarrier number 1 is the lowest, and the number of xDSL subcarriers, upstream (NSCus) is the
54// highest subcarrier that can be transmitted in the upstream direction. For [ITUT-G.992.3],
55// [ITUT-G.992.4] and [ITUT-G.992.5], it is defined in the corresponding Recommendation. For Annex
56// A of [ITUT-G.992.1] and [ITUT G.992.2], NSCus-= 32 and for Annex B of [ITUT-G.992.1], NSCus-=
57// 64. (R, W, setbycreate) (mandatory) (8-bytes)
58//
59type XdslSubcarrierMaskingUpstreamProfile struct {
60 ManagedEntityDefinition
61 Attributes AttributeValueMap
62}
63
Chip Boling8cdd6392022-01-27 08:43:37 -060064// Attribute name constants
65
66const XdslSubcarrierMaskingUpstreamProfile_UpstreamSubcarrierMask = "UpstreamSubcarrierMask"
67
Chip Boling6e27b352020-02-14 09:10:01 -060068func init() {
69 xdslsubcarriermaskingupstreamprofileBME = &ManagedEntityDefinition{
70 Name: "XdslSubcarrierMaskingUpstreamProfile",
Chip Boling8cdd6392022-01-27 08:43:37 -060071 ClassID: XdslSubcarrierMaskingUpstreamProfileClassID,
Chip Boling6e27b352020-02-14 09:10:01 -060072 MessageTypes: mapset.NewSetWith(
73 Create,
74 Delete,
75 Get,
76 Set,
77 ),
78 AllowedAttributeMask: 0x8000,
79 AttributeDefinitions: AttributeDefinitionMap{
Chip Boling8cdd6392022-01-27 08:43:37 -060080 0: Uint16Field(ManagedEntityID, PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
81 1: Uint64Field(XdslSubcarrierMaskingUpstreamProfile_UpstreamSubcarrierMask, UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
Chip Boling6e27b352020-02-14 09:10:01 -060082 },
83 Access: CreatedByOlt,
84 Support: UnknownSupport,
85 }
86}
87
88// NewXdslSubcarrierMaskingUpstreamProfile (class ID 109) creates the basic
89// Managed Entity definition that is used to validate an ME of this type that
90// is received from or transmitted to the OMCC.
91func NewXdslSubcarrierMaskingUpstreamProfile(params ...ParamData) (*ManagedEntity, OmciErrors) {
92 return NewManagedEntity(*xdslsubcarriermaskingupstreamprofileBME, params...)
93}