blob: d3d2ed690c88480ca6a7764db06d80bcd73874d7 [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// Dot1RateLimiterClassID is the 16-bit ID for the OMCI
29// Managed entity Dot1 rate limiter
30const Dot1RateLimiterClassID ClassID = ClassID(298)
31
32var dot1ratelimiterBME *ManagedEntityDefinition
33
34// Dot1RateLimiter (class ID #298)
35// This ME allows rate limits to be defined for various types of upstream traffic that are
36// processed by IEEE 802.1 bridges or related structures.
37//
38// Relationships
39// An instance of this ME may be linked to an instance of a MAC bridge service profile or an IEEE
40// 802.1p mapper.
41//
42// Attributes
43// Managed Entity Id
44// Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
45// (mandatory) (2-bytes)
46//
47// Parent Me Pointer
48// Parent ME pointer: This attribute points to an instance of a ME. The type of ME is determined by
49// the TP type attribute. (R,-W, setbycreate) (mandatory) (2-bytes)
50//
51// Tp Type
52// (R,-W, setbycreate) (mandatory) (1-byte)
53//
54// Upstream Unicast Flood Rate Pointer
55// Upstream unicast flood rate pointer: This attribute points to an instance of the traffic
56// descriptor that governs the rate of upstream unicast packets whose DA is unknown to the bridge.
57// A null pointer specifies that no administrative limit is to be imposed. (R,-W, setbycreate)
58// (optional) (2-bytes)
59//
60// Upstream Broadcast Rate Pointer
61// Upstream broadcast rate pointer: This attribute points to an instance of the traffic descriptor
62// that governs the rate of upstream broadcast packets. A null pointer specifies that no
63// administrative limit is to be imposed. (R,-W, setbycreate) (optional) (2-bytes)
64//
65// Upstream Multicast Payload Rate Pointer
66// Upstream multicast payload rate pointer: This attribute points to an instance of the traffic
67// descriptor that governs the rate of upstream multicast payload packets. A null pointer specifies
68// that no administrative limit is to be imposed. (R,-W, setbycreate) (optional) (2-bytes)
69//
70type Dot1RateLimiter struct {
71 ManagedEntityDefinition
72 Attributes AttributeValueMap
73}
74
75func init() {
76 dot1ratelimiterBME = &ManagedEntityDefinition{
77 Name: "Dot1RateLimiter",
78 ClassID: 298,
79 MessageTypes: mapset.NewSetWith(
80 Create,
81 Delete,
82 Get,
83 Set,
84 ),
85 AllowedAttributeMask: 0xf800,
86 AttributeDefinitions: AttributeDefinitionMap{
87 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
88 1: Uint16Field("ParentMePointer", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
89 2: ByteField("TpType", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
90 3: Uint16Field("UpstreamUnicastFloodRatePointer", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 3),
91 4: Uint16Field("UpstreamBroadcastRatePointer", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 4),
92 5: Uint16Field("UpstreamMulticastPayloadRatePointer", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 5),
93 },
94 Access: CreatedByOlt,
95 Support: UnknownSupport,
96 }
97}
98
99// NewDot1RateLimiter (class ID 298) creates the basic
100// Managed Entity definition that is used to validate an ME of this type that
101// is received from or transmitted to the OMCC.
102func NewDot1RateLimiter(params ...ParamData) (*ManagedEntity, OmciErrors) {
103 return NewManagedEntity(*dot1ratelimiterBME, params...)
104}