blob: 2b5171ad19469c802f9137327d5cf6b44c8d6c31 [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 */
Andrea Campanella7167ebb2020-02-24 09:56:38 +010017 /*
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// XtuDataGatheringConfigurationClassID is the 16-bit ID for the OMCI
29// Managed entity xTU data gathering configuration
30const XtuDataGatheringConfigurationClassID ClassID = ClassID(413)
31
32var xtudatagatheringconfigurationBME *ManagedEntityDefinition
33
34// XtuDataGatheringConfiguration (class ID #413)
35// This ME defines configurations specific to data gathering.
36//
37// An instance of this ME is created and deleted by the OLT.
38//
39// Relationships
40// An instance of this ME may be associated with zero or more instances of the PPTP xDSL UNI part
41// 1.
42//
43// Attributes
44// Managed Entity Id
45// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
46// identical ID, this ME is implicitly linked to an instance of the PPTP xDSL UNI part 1 ME.
47// (R,-set-by-create) (mandatory) (2 bytes)
48//
49// Logging Depth Event Percentage Per Event _ Vtu_O Logging_Depth_Event_Percentage_Oi Table
50// Logging depth event percentage per event - VTU-O (LOGGING_DEPTH_EVENT_PERCENTAGE_Oi) table: This
51// parameter is the percentage of the data gathering event buffer assigned to event type i at the
52// VTU-O. See clause 7.3.6.1 of [ITU-T G.997.1]. Each element in the table consists of 2-bytes,
53// where the first byte is event type i, and the second byte is the percentage of event type i
54// defined as the integer value multiplied by 1%. (R, W) (optional) (2- N-bytes for N event types)
55//
56// Logging Depth Event Percentage Per Event _ Vtu_R Logging_Depth_Event_Percentage_Ri Table
57// Logging depth event percentage per event - VTU-R (LOGGING_DEPTH_EVENT_PERCENTAGE_Ri) table: This
58// parameter is the percentage of the data gathering event buffer assigned to event type i at the
59// VTU-R. See clause 7.3.6.2 of [ITU-T G.997.1]. Each element in the table consists of 2-bytes,
60// where the first byte is event type i, and the second byte is the percentage of event type i
61// defined as the integer value multiplied by 1%. (R, W) (optional) (2- N-bytes for N event types)
62//
63// Logging Depth For Vtu_O Reporting _ Vtu_R Logging_Depth_Reporting_O
64// Logging depth for VTU-O reporting - VTU-R (LOGGING_DEPTH_REPORTING_O): This parameter is the
65// logging depth that is requested for reporting the VTU-O event trace buffer in the COMIB, in
66// number of 6-byte data gathering records. See clause 7.3.6.3 of [ITU-T G.997.1]. (R, W)
67// (optional) (2-bytes)
68//
69// Logging Depth For Vtu_R Reporting _ Vtu_R Logging_Depth_Reporting_R
70// Logging depth for VTU-R reporting - VTU-R (LOGGING_DEPTH_REPORTING_R): This parameter is the
71// logging depth that is requested for reporting the VTU-R event trace buffer over the embedded
72// operations channel (eoc), in number of 6-byte data gathering records. See clause 7.3.6.4 of
73// [ITU-T G.997.1]. (R, W) (optional) (2-bytes)
74//
75// Logging Data Report Newer Events First _ Vtu_R Logging_Report_Newer_First
76// Logging data report newer events first - VTU-R (LOGGING_REPORT_NEWER_FIRST): This parameter
77// determines whether the VTU-R to reports newer events first or older events first. See clause
78// 7.3.6.4 of [ITU-T G.997.1]. False is mapped to 0, true is mapped to 1. (R, W) (optional)
79// (1-byte)
80//
81type XtuDataGatheringConfiguration struct {
82 ManagedEntityDefinition
83 Attributes AttributeValueMap
84}
85
86func init() {
87 xtudatagatheringconfigurationBME = &ManagedEntityDefinition{
88 Name: "XtuDataGatheringConfiguration",
89 ClassID: 413,
90 MessageTypes: mapset.NewSetWith(
91 Create,
92 Delete,
93 Get,
94 GetNext,
95 Set,
96 ),
97 AllowedAttributeMask: 0xf800,
98 AttributeDefinitions: AttributeDefinitionMap{
99 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
100 1: TableField("LoggingDepthEventPercentagePerEventVtuOLoggingDepthEventPercentageOiTable", TableAttributeType, 0x8000, TableInfo{nil, 2}, mapset.NewSetWith(Read, Write), false, true, false, 1),
101 2: TableField("LoggingDepthEventPercentagePerEventVtuRLoggingDepthEventPercentageRiTable", TableAttributeType, 0x4000, TableInfo{nil, 2}, mapset.NewSetWith(Read, Write), false, true, false, 2),
102 3: Uint16Field("LoggingDepthForVtuOReportingVtuRLoggingDepthReportingO", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), false, true, false, 3),
103 4: Uint16Field("LoggingDepthForVtuRReportingVtuRLoggingDepthReportingR", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, true, false, 4),
104 5: ByteField("LoggingDataReportNewerEventsFirstVtuRLoggingReportNewerFirst", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, true, false, 5),
105 },
106 Access: CreatedByOlt,
107 Support: UnknownSupport,
108 }
109}
110
111// NewXtuDataGatheringConfiguration (class ID 413) creates the basic
112// Managed Entity definition that is used to validate an ME of this type that
113// is received from or transmitted to the OMCC.
114func NewXtuDataGatheringConfiguration(params ...ParamData) (*ManagedEntity, OmciErrors) {
115 return NewManagedEntity(*xtudatagatheringconfigurationBME, params...)
116}