blob: 069b25c3243e5cb4053dbda7598ae6cb5ae652f1 [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// GemPortNetworkCtpPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity GEM port network CTP performance monitoring history data
30const GemPortNetworkCtpPerformanceMonitoringHistoryDataClassID ClassID = ClassID(341)
31
32var gemportnetworkctpperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// GemPortNetworkCtpPerformanceMonitoringHistoryData (class ID #341)
35// This ME collects GEM frame PM data associated with a GEM port network CTP. Instances of this ME
36// are created and deleted by the OLT.
37//
38// NOTE 1 - One might expect to find some form of impaired or discarded frame count associated with
39// a GEM port. However, the only impairment that might be detected at the GEM frame level would be
40// a corrupted GEM frame header. In this case, no part of the header could be considered reliable
41// including the port ID. For this reason, there is no impaired or discarded frame count in this
42// ME.
43//
44// NOTE 2 - This ME replaces the GEM port performance history data ME and is preferred for new
45// implementations.
46//
47// For a complete discussion of generic PM architecture, refer to clause I.4.
48//
49// Relationships
50// An instance of this ME is associated with an instance of the GEM port network CTP ME.
51//
52// Attributes
53// Managed Entity Id
54// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
55// identical ID, this ME is implicitly linked to an instance of the GEM port network CTP. (R,
56// setbycreate) (mandatory) (2-bytes)
57//
58// Interval End Time
59// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
60// (mandatory) (1-byte)
61//
62// Threshold Data 1_2 Id
63// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
64// contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
65// data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)
66//
67// Transmitted Gem Frames
68// Transmitted GEM frames: This attribute counts GEM frames transmitted on the monitored GEM port.
69// (R) (mandatory) (4-bytes)
70//
71// Received Gem Frames
72// Received GEM frames: This attribute counts GEM frames received correctly on the monitored GEM
73// port. A correctly received GEM frame is one that does not contain uncorrectable errors and has a
74// valid header error check (HEC). (R) (mandatory) (4-bytes)
75//
76// Received Payload Bytes
77// Received payload bytes: This attribute counts user payload bytes received on the monitored GEM
78// port. (R) (mandatory) (8-bytes)
79//
80// Transmitted Payload Bytes
81// Transmitted payload bytes: This attribute counts user payload bytes transmitted on the monitored
82// GEM port. (R) (mandatory) (8-bytes)
83//
84// Encryption Key Errors
85// NOTE 4 - GEM PM counts each non-idle GEM frame, whether it contains an entire user frame or only
86// a fragment of a user frame.
87//
88type GemPortNetworkCtpPerformanceMonitoringHistoryData struct {
89 ManagedEntityDefinition
90 Attributes AttributeValueMap
91}
92
93func init() {
94 gemportnetworkctpperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
95 Name: "GemPortNetworkCtpPerformanceMonitoringHistoryData",
96 ClassID: 341,
97 MessageTypes: mapset.NewSetWith(
98 Create,
99 Delete,
100 Get,
101 Set,
Chip Boling2d51f052021-02-09 09:04:15 -0600102 GetCurrentData,
Chip Boling6e27b352020-02-14 09:10:01 -0600103 ),
104 AllowedAttributeMask: 0xfe00,
105 AttributeDefinitions: AttributeDefinitionMap{
106 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
107 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
108 2: Uint16Field("ThresholdData12Id", PointerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
109 3: Uint32Field("TransmittedGemFrames", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
110 4: Uint32Field("ReceivedGemFrames", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
111 5: Uint64Field("ReceivedPayloadBytes", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
112 6: Uint64Field("TransmittedPayloadBytes", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
113 7: Uint32Field("EncryptionKeyErrors", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, true, false, 7),
114 },
115 Access: CreatedByOlt,
116 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600117 Alarms: AlarmMap{
118 1: "Encryption key errors",
119 },
Chip Boling6e27b352020-02-14 09:10:01 -0600120 }
121}
122
123// NewGemPortNetworkCtpPerformanceMonitoringHistoryData (class ID 341) creates the basic
124// Managed Entity definition that is used to validate an ME of this type that
125// is received from or transmitted to the OMCC.
126func NewGemPortNetworkCtpPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
127 return NewManagedEntity(*gemportnetworkctpperformancemonitoringhistorydataBME, params...)
128}