blob: 000de15d1e328a72eb4a08e2676f0c31a1591cf9 [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// TrafficSchedulerClassID is the 16-bit ID for the OMCI
29// Managed entity Traffic scheduler
30const TrafficSchedulerClassID ClassID = ClassID(278)
31
32var trafficschedulerBME *ManagedEntityDefinition
33
34// TrafficScheduler (class ID #278)
35// NOTE 1 - In [ITU-T G.984.4], this ME is called a traffic scheduler-G.
36//
37// An instance of this ME represents a logical object that can control upstream GEM packets. A
38// traffic scheduler can accommodate GEM packets after a priority queue or other traffic scheduler
39// and transfer them towards the next traffic scheduler or T-CONT. Because T-CONTs and traffic
40// schedulers are created autonomously by the ONU, the ONU vendor predetermines the most complex
41// traffic handling model it is prepared to support; the OLT may use less than the ONU's full
42// capabilities, but cannot ask for more. See Appendix II for more details.
43//
44// After the ONU creates instances of the T-CONT ME, it then autonomously creates instances of the
45// traffic scheduler ME.
46//
47// Relationships
48// The traffic scheduler ME may be related to a T-CONT or other traffic schedulers through pointer
49// attributes.
50//
51// Attributes
52// Managed Entity Id
53// Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
54// number indicates the physical capability that realizes the traffic scheduler. The first byte is
55// the slot ID of the circuit pack with which this traffic scheduler is associated. For a traffic
56// scheduler that is not associated with a circuit pack, the first byte is 0xFF. The second byte is
57// the traffic scheduler id, assigned by the ONU itself. Traffic schedulers are numbered in
58// ascending order with the range 0..0xFF in each circuit pack or in the ONU core. (R) (mandatory)
59// (2-bytes)
60//
61// T_Cont Pointer
62// NOTE 2 - This attribute is read-only unless otherwise specified by the QoS configuration
63// flexibility attribute of the ONU2-G ME. If flexible configuration is not supported, the ONU
64// should reject an attempt to set the TCONT pointer attribute with a parameter error result-reason
65// code.
66//
67// Traffic Scheduler Pointer
68// Traffic scheduler pointer: This attribute points to another traffic scheduler ME instance that
69// may serve this traffic scheduler. This pointer is used when this traffic scheduler is connected
70// to another traffic scheduler; it is null (0) otherwise. (R) (mandatory) (2-bytes)
71//
72// Policy
73// NOTE 3 - This attribute is read-only unless otherwise specified by the QoS configuration
74// flexibility attribute of the ONU2-G ME. If flexible configuration is not supported, the ONU
75// should reject an attempt to set the policy attribute with a parameter error result-reason code.
76//
77// Priority_Weight
78// Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte)
79//
80type TrafficScheduler struct {
81 ManagedEntityDefinition
82 Attributes AttributeValueMap
83}
84
85func init() {
86 trafficschedulerBME = &ManagedEntityDefinition{
87 Name: "TrafficScheduler",
88 ClassID: 278,
89 MessageTypes: mapset.NewSetWith(
90 Get,
91 Set,
92 ),
93 AllowedAttributeMask: 0xf000,
94 AttributeDefinitions: AttributeDefinitionMap{
95 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
96 1: Uint16Field("TContPointer", PointerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1),
97 2: Uint16Field("TrafficSchedulerPointer", PointerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, false, false, 2),
98 3: ByteField("Policy", EnumerationAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), false, false, false, 3),
99 4: ByteField("PriorityWeight", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, false, false, 4),
100 },
101 Access: CreatedByOnu,
102 Support: UnknownSupport,
103 }
104}
105
106// NewTrafficScheduler (class ID 278) creates the basic
107// Managed Entity definition that is used to validate an ME of this type that
108// is received from or transmitted to the OMCC.
109func NewTrafficScheduler(params ...ParamData) (*ManagedEntity, OmciErrors) {
110 return NewManagedEntity(*trafficschedulerBME, params...)
111}