blob: a1c09d685a5aa887af7b099cd4d3caeeeb7b2bd0 [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// XdslSubcarrierMaskingUpstreamProfileClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL subcarrier masking upstream profile
30const XdslSubcarrierMaskingUpstreamProfileClassID ClassID = ClassID(109)
31
32var xdslsubcarriermaskingupstreamprofileBME *ManagedEntityDefinition
33
34// XdslSubcarrierMaskingUpstreamProfile (class ID #109)
35// 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
44// Managed entity ID: This attribute uniquely identifies each instance of this ME. The value 0 is
45// reserved. (R, setbycreate) (mandatory) (2-bytes)
46//
47// Upstream Subcarrier Mask
48// Subcarrier number 1 is the lowest, and the number of xDSL subcarriers, upstream (NSCus) is the
49// highest subcarrier that can be transmitted in the upstream direction. For [ITUT-G.992.3],
50// [ITUT-G.992.4] and [ITUT-G.992.5], it is defined in the corresponding Recommendation. For Annex
51// A of [ITUT-G.992.1] and [ITUT G.992.2], NSCus-= 32 and for Annex B of [ITUT-G.992.1], NSCus-=
52// 64. (R, W, setbycreate) (mandatory) (8-bytes)
53//
54type XdslSubcarrierMaskingUpstreamProfile struct {
55 ManagedEntityDefinition
56 Attributes AttributeValueMap
57}
58
59func init() {
60 xdslsubcarriermaskingupstreamprofileBME = &ManagedEntityDefinition{
61 Name: "XdslSubcarrierMaskingUpstreamProfile",
62 ClassID: 109,
63 MessageTypes: mapset.NewSetWith(
64 Create,
65 Delete,
66 Get,
67 Set,
68 ),
69 AllowedAttributeMask: 0x8000,
70 AttributeDefinitions: AttributeDefinitionMap{
71 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
72 1: Uint64Field("UpstreamSubcarrierMask", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
73 },
74 Access: CreatedByOlt,
75 Support: UnknownSupport,
76 }
77}
78
79// NewXdslSubcarrierMaskingUpstreamProfile (class ID 109) creates the basic
80// Managed Entity definition that is used to validate an ME of this type that
81// is received from or transmitted to the OMCC.
82func NewXdslSubcarrierMaskingUpstreamProfile(params ...ParamData) (*ManagedEntity, OmciErrors) {
83 return NewManagedEntity(*xdslsubcarriermaskingupstreamprofileBME, params...)
84}