blob: 560466defd23576ca71a96a6320ea99eb283f7ce [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 */
Chip Boling34ebcb62021-02-02 12:13:58 -060017/*
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// Aal5PerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity AAL5 performance monitoring history data
30const Aal5PerformanceMonitoringHistoryDataClassID ClassID = ClassID(18)
31
32var aal5performancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// Aal5PerformanceMonitoringHistoryData (class ID #18)
35// This ME collects PM data as a result of performing segmentation and reassembly (SAR) and
36// convergence sublayer (CS) level protocol monitoring. Instances of this ME are created and
37// deleted by 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 an IW VCC TP that represents AAL5
43// functions.
44//
45// Attributes
46// Managed Entity Id
47// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
48// identical ID, this ME is implicitly linked to an instance of the IW VCC TP. (R, setbycreate)
49// (mandatory) (2-bytes)
50//
51// Interval End Time
52// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
53// (mandatory) (1-byte)
54//
55// Threshold Data 1_2 Id
56// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
57// contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
58// data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)
59//
60// Sum Of Invalid Cs Field Errors
61// Sum of invalid CS field errors: This attribute counts the sum of invalid CS field errors. For
62// AAL type 5, this attribute is a single count of the number of CS PDUs discarded due to one of
63// the following error conditions: invalid common part indicator (CPI), oversized received SDU, or
64// length violation. (R) (mandatory) (4-bytes)
65//
66// Crc Violations
67// CRC violations: This attribute counts CRC violations detected on incoming SAR PDUs. (R)
68// (mandatory) (4-bytes)
69//
70// Reassembly Timer Expirations
71// Reassembly timer expirations: This attribute counts reassembly timer expirations. (R) (mandatory
72// if reassembly timer is implemented) (4-bytes)
73//
74// Buffer Overflows
75// Buffer overflows: This attribute counts the number of times where there was not enough buffer
76// space for a reassembled packet. (R) (mandatory) (4-bytes)
77//
78// Encap Protocol Errors
79// Encap protocol errors: This attribute counts the number of times that [IETF RFC 2684]
80// encapsulation protocol detected a bad header. (R) (mandatory) (4-bytes)
81//
82type Aal5PerformanceMonitoringHistoryData struct {
83 ManagedEntityDefinition
84 Attributes AttributeValueMap
85}
86
87func init() {
88 aal5performancemonitoringhistorydataBME = &ManagedEntityDefinition{
89 Name: "Aal5PerformanceMonitoringHistoryData",
90 ClassID: 18,
91 MessageTypes: mapset.NewSetWith(
92 Create,
93 Delete,
94 Get,
95 Set,
Chip Boling2d51f052021-02-09 09:04:15 -060096 GetCurrentData,
Chip Boling6e27b352020-02-14 09:10:01 -060097 ),
98 AllowedAttributeMask: 0xfe00,
99 AttributeDefinitions: AttributeDefinitionMap{
100 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
101 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
102 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
103 3: Uint32Field("SumOfInvalidCsFieldErrors", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
104 4: Uint32Field("CrcViolations", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
105 5: Uint32Field("ReassemblyTimerExpirations", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
106 6: Uint32Field("BufferOverflows", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
107 7: Uint32Field("EncapProtocolErrors", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
108 },
109 Access: CreatedByOlt,
110 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600111 Alarms: AlarmMap{
112 0: "Invalid fields",
113 1: "CRC violation",
114 2: "Reassembly timer expirations",
115 3: "Buffer overflows",
116 4: "Encap protocol errors",
117 },
Chip Boling6e27b352020-02-14 09:10:01 -0600118 }
119}
120
121// NewAal5PerformanceMonitoringHistoryData (class ID 18) creates the basic
122// Managed Entity definition that is used to validate an ME of this type that
123// is received from or transmitted to the OMCC.
124func NewAal5PerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
125 return NewManagedEntity(*aal5performancemonitoringhistorydataBME, params...)
126}