blob: eb015edac8f30be4867fd848ec9e210107c1171a [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// CallControlPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity Call control performance monitoring history data
30const CallControlPerformanceMonitoringHistoryDataClassID ClassID = ClassID(140)
31
32var callcontrolperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// CallControlPerformanceMonitoringHistoryData (class ID #140)
35// This ME collects PM data related to the call control channel. Instances of this ME are created
36// and deleted by the OLT.
37//
38// For a complete discussion of generic PM architecture, refer to clause I.4.
39//
40// Relationships
41// An instance of this ME is associated with an instance of the PPTP POTS UNI ME.
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 POTS UNI. (R, setbycreate)
47// (mandatory) (2-bytes)
48//
49// Interval End Time
50// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
51// (mandatory) (1-byte)
52//
53// Threshold Data 1_2 Id
54// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
55// contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
56// data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)
57//
58// Call Setup Failures
59// Call setup failures: This attribute counts call set-up failures. (R) (mandatory) (4-bytes)
60//
61// Call Setup Timer
62// Call setup timer: This attribute is a high water-mark that records the longest duration of a
63// single call set-up detected during this interval. Time is measured in milliseconds from the time
64// an initial set-up was requested by the subscriber until the time at which a response was
65// provided to the subscriber in the form of busy tone, audible ring tone, etc. (R) (mandatory)
66// (4-bytes)
67//
68// Call Terminate Failures
69// Call terminate failures: This attribute counts the number of calls that were terminated with
70// cause. (R) (mandatory) (4-bytes)
71//
72// Analog Port Releases
73// Analog port releases: This attribute counts the number of analogue port releases without
74// dialling detected (abandoned calls). (R) (mandatory) (4-bytes)
75//
76// Analog Port Off_Hook Timer
77// Analog port off-hook timer: This attribute is a high water-mark that records the longest period
78// of a single off-hook detected on the analogue port. Time is measured in milliseconds. (R)
79// (mandatory) (4-bytes)
80//
81type CallControlPerformanceMonitoringHistoryData struct {
82 ManagedEntityDefinition
83 Attributes AttributeValueMap
84}
85
86func init() {
87 callcontrolperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
88 Name: "CallControlPerformanceMonitoringHistoryData",
89 ClassID: 140,
90 MessageTypes: mapset.NewSetWith(
91 Create,
92 Delete,
93 Get,
94 Set,
95 ),
96 AllowedAttributeMask: 0xfe00,
97 AttributeDefinitions: AttributeDefinitionMap{
98 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
99 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
100 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
101 3: Uint32Field("CallSetupFailures", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
102 4: Uint32Field("CallSetupTimer", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
103 5: Uint32Field("CallTerminateFailures", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
104 6: Uint32Field("AnalogPortReleases", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
105 7: Uint32Field("AnalogPortOffHookTimer", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
106 },
107 Access: CreatedByOlt,
108 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600109 Alarms: AlarmMap{
110 0: "CCPM call set-up fail",
111 1: "CCPM set-up timeout",
112 2: "CCPM call terminate",
113 3: "CCPM port release with no dialling",
114 4: "CCPM port offhook timeout",
115 },
Chip Boling6e27b352020-02-14 09:10:01 -0600116 }
117}
118
119// NewCallControlPerformanceMonitoringHistoryData (class ID 140) creates the basic
120// Managed Entity definition that is used to validate an ME of this type that
121// is received from or transmitted to the OMCC.
122func NewCallControlPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
123 return NewManagedEntity(*callcontrolperformancemonitoringhistorydataBME, params...)
124}