blob: b0b0ce59bed13d92227b71536ab605ec8b578bdf [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// TwdmChannelManagedEntityClassID is the 16-bit ID for the OMCI
29// Managed entity TWDM channel managed entity
Chip Boling610117d2021-09-09 11:24:34 -050030const TwdmChannelManagedEntityClassID = ClassID(443) // 0x01bb
Chip Boling6e27b352020-02-14 09:10:01 -060031
32var twdmchannelmanagedentityBME *ManagedEntityDefinition
33
Chip Boling610117d2021-09-09 11:24:34 -050034// TwdmChannelManagedEntity (Class ID: #443 / 0x01bb)
Chip Boling6e27b352020-02-14 09:10:01 -060035// This ME provides an anchor for the MEs involved in collection of PM statistics per TWDM channel,
36// as stipulated by clause 14 of [ITU-T-G.989.3]. Instances of this ME are instantiated
37// autonomously by the ONU.
38//
39// Relationships
40// One or more instances of this ME are implicitly associated with the TWDM System profile ME. The
41// number of instances created is announced by the total TWDM channel number attribute of the TWDM
42// system profile ME.
43//
44// Attributes
45// Managed Entity Id
Chip Boling610117d2021-09-09 11:24:34 -050046// This attribute uniquely identifies each instance of this ME. This 2-byte number is represented
47// as 0xSSBB, where SS indicates the ONU slot ID, and BB is the TWDM channel ME number assigned by
48// the ONU itself, starting from 0 in the ascending order. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060049//
50// Active Channel Indication
Chip Boling610117d2021-09-09 11:24:34 -050051// The default value is false. The ONU sets the attribute to true when it receives the
52// Channel_Profile PLOAM messages for that channel. The ONU clears the attribute when it receives
53// the Channel_Profile PLOAM message marked ``void'' for that channel. (R) (mandatory) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060054//
55// Operational Channel Indication
Chip Boling610117d2021-09-09 11:24:34 -050056// A Boolean attribute that is set to true for an active TWDM channel in which the ONT is currently
57// operating. The operational statistic is accumulated in the PM history data MEs associated with
58// that TWDM channel. (R) (mandatory) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060059//
60// Downstream Wavelength Channel
Chip Boling610117d2021-09-09 11:24:34 -050061// For an active TWDM channel, this attribute identifies the downstream wavelength channel in
62// reference to Table 11-2 of [ITU-T-G.989.2]. For an inactive channel it has value 0xFF. (R)
63// (mandatory) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060064//
65// Upstream Wavelength Channel
Chip Boling610117d2021-09-09 11:24:34 -050066// For an active TWDM channel, this attribute identifies the upstream wavelength channel in
67// reference to Table VIII-5 of [ITU-T-G.989.2]. For an inactive channel its value of 0xFF. (R)
68// (mandatory) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060069//
70type TwdmChannelManagedEntity struct {
71 ManagedEntityDefinition
72 Attributes AttributeValueMap
73}
74
75func init() {
76 twdmchannelmanagedentityBME = &ManagedEntityDefinition{
77 Name: "TwdmChannelManagedEntity",
78 ClassID: 443,
79 MessageTypes: mapset.NewSetWith(
80 Get,
81 ),
82 AllowedAttributeMask: 0xf000,
83 AttributeDefinitions: AttributeDefinitionMap{
84 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
85 1: ByteField("ActiveChannelIndication", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
86 2: ByteField("OperationalChannelIndication", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, false, false, 2),
87 3: ByteField("DownstreamWavelengthChannel", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
88 4: ByteField("UpstreamWavelengthChannel", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
89 },
90 Access: CreatedByOnu,
91 Support: UnknownSupport,
92 }
93}
94
95// NewTwdmChannelManagedEntity (class ID 443) creates the basic
96// Managed Entity definition that is used to validate an ME of this type that
97// is received from or transmitted to the OMCC.
98func NewTwdmChannelManagedEntity(params ...ParamData) (*ManagedEntity, OmciErrors) {
99 return NewManagedEntity(*twdmchannelmanagedentityBME, params...)
100}