blob: b79d889b5a973f01ce2202517575f8134646d869 [file] [log] [blame]
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -07001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
Matteo Scandolof9d43412021-01-12 11:11:34 -08003 * Copyright 2020-present Open Networking Foundation
4
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -07005 * 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
Matteo Scandolof9d43412021-01-12 11:11:34 -08008
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -07009 * http://www.apache.org/licenses/LICENSE-2.0
Matteo Scandolof9d43412021-01-12 11:11:34 -080010
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070011 * 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 */
Matteo Scandolof9d43412021-01-12 11:11:34 -080017 /*
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070018 * 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 */
Matteo Scandolof9d43412021-01-12 11:11:34 -080023
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070024package generated
25
26import "github.com/deckarep/golang-set"
27
Matteo Scandolof9d43412021-01-12 11:11:34 -080028// TwdmChannelXgemPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity TWDM channel XGEM performance monitoring history data
30const TwdmChannelXgemPerformanceMonitoringHistoryDataClassID ClassID = ClassID(445)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070031
32var twdmchannelxgemperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// TwdmChannelXgemPerformanceMonitoringHistoryData (class ID #445)
35// This ME collects certain XGEM-related PM data associated with the slot/circuit pack, hosting one
36// or more ANI-G MEs, for a specific TWDM channel. Instances of this ME are created and deleted by
37// the OLT.
38//
39// For a complete discussion of generic PM architecture, refer to clause I.4.
40//
41// Relationships
42// An instance of this ME is associated with an instance of TWDM channel ME.
43//
44// Attributes
45// Managed Entity Id
46// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
47// identical ID, this ME is implicitly linked to an instance of the TWDM channel ME. (R,
Matteo Scandolof9d43412021-01-12 11:11:34 -080048// setbycreate) (mandatory) (2-bytes)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070049//
50// Interval End Time
Matteo Scandolof9d43412021-01-12 11:11:34 -080051// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
52// (mandatory) (1-byte)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070053//
Matteo Scandolof9d43412021-01-12 11:11:34 -080054// Threshold Data 64 Bit Id
55// Threshold data 64-bit ID: This attribute points to an instance of the threshold data 64-bit ME
56// that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070057//
58// Total Transmitted Xgem Frames
59// Total transmitted XGEM frames: The counter aggregated across all XGEM ports of the given ONU.
Matteo Scandolof9d43412021-01-12 11:11:34 -080060// (R) (mandatory) (8-byte)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070061//
62// Transmitted Xgem Frames With Lf Bit Not Set
63// Transmitted XGEM frames with LF bit not set: The counter aggregated across all XGEM ports of the
Matteo Scandolof9d43412021-01-12 11:11:34 -080064// given ONU identifies the number of fragmentation operations. (R) (mandatory) (8-byte)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070065//
66// Total Received Xgem Frames
67// Total received XGEM frames: The counter aggregated across all XGEM ports of the given ONU. (R)
Matteo Scandolof9d43412021-01-12 11:11:34 -080068// (mandatory) (8-byte)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070069//
70// Received Xgem Frames With Xgem Header Hec Errors
71// Received XGEM frames with XGEM header HEC errors: The counter aggregated across all XGEM ports
72// of the given ONU identifies the number of loss XGEM frame delineation events. (R) (mandatory)
Matteo Scandolof9d43412021-01-12 11:11:34 -080073// (8-byte)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070074//
75// Fs Words Lost To Xgem Header Hec Errors
76// FS words lost to XGEM header HEC errors: The counter of the FS frame words lost due to XGEM
Matteo Scandolof9d43412021-01-12 11:11:34 -080077// frame header errors that cause loss of XGEM frame delineation. (R) (mandatory) (8-byte)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070078//
79// Xgem Encryption Key Errors
80// XGEM encryption key errors: The counter aggregated across all XGEM ports of the given ONU
81// identifies the number of received XGEM frames that have to be discarded because of unknown or
82// invalid encryption key. The number is included into the Total received XGEM frame count above.
Matteo Scandolof9d43412021-01-12 11:11:34 -080083// (R) (mandatory) (8-byte)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070084//
85// Total Transmitted Bytes In Non_Idle Xgem Frames
86// Total transmitted bytes in non-idle XGEM frames: The counter aggregated across all XGEM ports of
Matteo Scandolof9d43412021-01-12 11:11:34 -080087// the given. (R) (mandatory) (8-byte)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070088//
89// Total Received Bytes In Non_Idle Xgem Frames
90// Total received bytes in non-idle XGEM frames: The counter aggregated across all XGEM ports of
Matteo Scandolof9d43412021-01-12 11:11:34 -080091// the given ONU. (R) (mandatory) (8-byte)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -070092//
93type TwdmChannelXgemPerformanceMonitoringHistoryData struct {
94 ManagedEntityDefinition
95 Attributes AttributeValueMap
96}
97
98func init() {
99 twdmchannelxgemperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
100 Name: "TwdmChannelXgemPerformanceMonitoringHistoryData",
101 ClassID: 445,
102 MessageTypes: mapset.NewSetWith(
103 Create,
104 Delete,
105 Get,
106 GetCurrentData,
107 Set,
108 ),
Matteo Scandolof9d43412021-01-12 11:11:34 -0800109 AllowedAttributeMask: 0xffc0,
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -0700110 AttributeDefinitions: AttributeDefinitionMap{
Matteo Scandolof9d43412021-01-12 11:11:34 -0800111 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
112 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
113 2: Uint16Field("ThresholdData64BitId", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
114 3: Uint64Field("TotalTransmittedXgemFrames", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
115 4: Uint64Field("TransmittedXgemFramesWithLfBitNotSet", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
116 5: Uint64Field("TotalReceivedXgemFrames", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
117 6: Uint64Field("ReceivedXgemFramesWithXgemHeaderHecErrors", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
118 7: Uint64Field("FsWordsLostToXgemHeaderHecErrors", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
119 8: Uint64Field("XgemEncryptionKeyErrors", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
120 9: Uint64Field("TotalTransmittedBytesInNonIdleXgemFrames", CounterAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
121 10: Uint64Field("TotalReceivedBytesInNonIdleXgemFrames", CounterAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -0700122 },
Matteo Scandolof9d43412021-01-12 11:11:34 -0800123 Access: CreatedByOlt,
124 Support: UnknownSupport,
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -0700125 }
126}
127
Matteo Scandolof9d43412021-01-12 11:11:34 -0800128// NewTwdmChannelXgemPerformanceMonitoringHistoryData (class ID 445) creates the basic
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -0700129// Managed Entity definition that is used to validate an ME of this type that
Matteo Scandolof9d43412021-01-12 11:11:34 -0800130// is received from or transmitted to the OMCC.
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -0700131func NewTwdmChannelXgemPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
Matteo Scandolof9d43412021-01-12 11:11:34 -0800132 return NewManagedEntity(*twdmchannelxgemperformancemonitoringhistorydataBME, params...)
Matteo Scandoloa6a3aee2019-11-26 13:30:14 -0700133}