blob: be7cccbc71cd4e136b275756091b6efa6c180076 [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 Boling6e27b352020-02-14 09:10:01 -060017
18package generated
19
20import "github.com/deckarep/golang-set"
21
22// XgPonUpstreamManagementPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
23// Managed entity XG-PON upstream management performance monitoring history data
24const XgPonUpstreamManagementPerformanceMonitoringHistoryDataClassID ClassID = ClassID(346)
25
26var xgponupstreammanagementperformancemonitoringhistorydataBME *ManagedEntityDefinition
27
28// XgPonUpstreamManagementPerformanceMonitoringHistoryData (class ID #346)
29// This ME collects PM data associated with the XG-PON TC layer. It counts upstream PLOAM messages
30// transmitted by the ONU.
31//
32// For a complete discussion of generic PM architecture, refer to clause I.4.
33//
34// Relationships
35// An instance of this ME is associated with an ANI-G.
36//
37// Attributes
38// Managed Entity Id
39// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
40// identical ID, this ME is implicitly linked to an instance of the ANI-G. (R, set-by-create)
41// (mandatory) (2-bytes)
42//
43// Interval End Time
44// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
45// (mandatory) (1-byte)
46//
47// Threshold Data 1_2 Id
48// Threshold data 1/2 ID: No thresholds are defined for this ME. For uniformity with other PM, the
49// attribute is retained and shown as mandatory, but it should be set to a null pointer. (R,-W,
50// set-by-create) (mandatory) (2-bytes)
51//
52// Upstream Ploam Message Count
53// Upstream PLOAM message count: This attribute counts PLOAM messages transmitted upstream,
54// excluding acknowledge messages. (R) (optional) (4-bytes)
55//
56// Serial_Number_Onu Message Count
57// Serial_number_ONU message count: This attribute counts Serial_number_ONU PLOAM messages
58// transmitted. (R) (optional) (4-bytes)
59//
60// Registration Message Count
61// Registration message count: This attribute counts Registration PLOAM messages transmitted. (R)
62// (optional) (4-bytes)
63//
64// Key_Report Message Count
65// Key_report message count: This attribute counts key_report PLOAM messages transmitted. (R)
66// (optional) (4-bytes)
67//
68// Acknowledge Message Count
69// Acknowledge message count: This attribute counts acknowledge PLOAM messages transmitted. It
70// includes all forms of acknowledgement (AK), including those transmitted in response to a PLOAM
71// grant when the ONU has nothing to send. (R) (optional) (4-bytes)
72//
73// Sleep_Request Message Count
74// Sleep_request message count: This attribute counts sleep_request PLOAM messages transmitted. (R)
75// (optional) (4-bytes)
76//
77type XgPonUpstreamManagementPerformanceMonitoringHistoryData struct {
78 ManagedEntityDefinition
79 Attributes AttributeValueMap
80}
81
82func init() {
83 xgponupstreammanagementperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
84 Name: "XgPonUpstreamManagementPerformanceMonitoringHistoryData",
85 ClassID: 346,
86 MessageTypes: mapset.NewSetWith(
87 Create,
88 Delete,
89 Get,
90 Set,
91 ),
92 AllowedAttributeMask: 0xff00,
93 AttributeDefinitions: AttributeDefinitionMap{
94 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
95 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
96 2: Uint16Field("ThresholdData12Id", PointerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
97 3: Uint32Field("UpstreamPloamMessageCount", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, true, false, 3),
98 4: Uint32Field("SerialNumberOnuMessageCount", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, true, false, 4),
99 5: Uint32Field("RegistrationMessageCount", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, true, false, 5),
100 6: Uint32Field("KeyReportMessageCount", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, true, false, 6),
101 7: Uint32Field("AcknowledgeMessageCount", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, true, false, 7),
102 8: Uint32Field("SleepRequestMessageCount", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, true, false, 8),
103 },
104 Access: CreatedByOlt,
105 Support: UnknownSupport,
106 }
107}
108
109// NewXgPonUpstreamManagementPerformanceMonitoringHistoryData (class ID 346) creates the basic
110// Managed Entity definition that is used to validate an ME of this type that
111// is received from or transmitted to the OMCC.
112func NewXgPonUpstreamManagementPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
113 return NewManagedEntity(*xgponupstreammanagementperformancemonitoringhistorydataBME, params...)
114}