blob: 0b334bf1fc36c8cee209a40a597e460011a48e95 [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 Boling2d51f052021-02-09 09:04:15 -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// EnergyConsumptionPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity Energy consumption performance monitoring history data
30const EnergyConsumptionPerformanceMonitoringHistoryDataClassID ClassID = ClassID(343)
31
32var energyconsumptionperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// EnergyConsumptionPerformanceMonitoringHistoryData (class ID #343)
35// This ME collects PM data associated with the ONU's energy consumption. The time spent in various
36// low-power states is recorded as a measure of their utility. Furthermore, the ONU may also
37// include the equivalent of a watt-hour meter, which can be sampled from time to time to measure
38// actual power consumed.
39//
40// For a complete discussion of generic PM architecture, refer to clause I.4.
41//
42// Relationships
43// An instance of this ME is associated with the ONU in its entirety.
44//
45// Attributes
46// Managed Entity Id
47// Managed entity ID: This attribute uniquely identifies each instance of this ME. The ME ID must
48// be 0. (R, set-by-create) (mandatory) (2-bytes)
49//
50// Interval End Time
51// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
52// (mandatory) (1-byte)
53//
54// Threshold Data 1_2 Id
55// Threshold data 1/2 ID: No thresholds are defined for this ME. For uniformity with other PMs, the
56// attribute is retained and shown as mandatory, but it should be set to a null pointer. (R,-W,
57// set-by-create) (mandatory) (2-bytes)
58//
59// Doze Time
60// Doze time: This attribute records the time during which the ONU was in doze energy conservation
61// mode, measured in microseconds. If watchful sleep is enabled in the ONU dynamic power management
62// control ME, the ONU ignores this attribute. (R) (mandatory) (4-bytes)
63//
64// Cyclic Sleep Time
65// Cyclic sleep time: This attribute records the time during which the ONU was in cyclic sleep
66// energy conservation mode, measured in microseconds. If watchful sleep is enabled in the ONU
67// dynamic power management control ME, the ONU ignores this attribute. (R) (mandatory) (4-bytes)
68//
69// Watchful Sleep Time
70// Watchful sleep time: This attribute records the time during which the ONU was in watchful sleep
71// energy conservation mode, measured in microseconds. (R) (mandatory) (4-bytes)
72//
73// Energy Consumed
74// Energy consumed: This attribute records the energy consumed by the ONU, measured in millijoules.
75// (R) (optional) (4-bytes)
76//
77type EnergyConsumptionPerformanceMonitoringHistoryData struct {
78 ManagedEntityDefinition
79 Attributes AttributeValueMap
80}
81
82func init() {
83 energyconsumptionperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
84 Name: "EnergyConsumptionPerformanceMonitoringHistoryData",
85 ClassID: 343,
86 MessageTypes: mapset.NewSetWith(
87 Create,
88 Delete,
89 Get,
90 Set,
Chip Boling2d51f052021-02-09 09:04:15 -060091 GetCurrentData,
Chip Boling6e27b352020-02-14 09:10:01 -060092 ),
93 AllowedAttributeMask: 0xfc00,
94 AttributeDefinitions: AttributeDefinitionMap{
95 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
96 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
97 2: Uint16Field("ThresholdData12Id", PointerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
98 3: Uint32Field("DozeTime", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
99 4: Uint32Field("CyclicSleepTime", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
100 5: Uint32Field("WatchfulSleepTime", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
101 6: Uint32Field("EnergyConsumed", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, true, false, 6),
102 },
103 Access: CreatedByOlt,
104 Support: UnknownSupport,
105 }
106}
107
108// NewEnergyConsumptionPerformanceMonitoringHistoryData (class ID 343) creates the basic
109// Managed Entity definition that is used to validate an ME of this type that
110// is received from or transmitted to the OMCC.
111func NewEnergyConsumptionPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
112 return NewManagedEntity(*energyconsumptionperformancemonitoringhistorydataBME, params...)
113}