blob: 9f91f49f177115b112f54011103c335ad9c80572 [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// OltGClassID is the 16-bit ID for the OMCI
29// Managed entity OLT-G
30const OltGClassID ClassID = ClassID(131)
31
32var oltgBME *ManagedEntityDefinition
33
34// OltG (class ID #131)
35// This optional ME identifies the OLT to which an ONU is connected. This ME provides a way for the
36// ONU to configure itself for operability with a particular OLT. It also provides a way for the
37// OLT to communicate the time of day to the ONU.
38//
39// An ONU that supports this ME automatically creates an instance of it. Immediately following the
40// start-up phase, the OLT should set the ONU to the desired configuration. Interpretation of the
41// OLT vendor ID, equipment ID and version attributes is a matter for negotiation between the two
42// vendors involved.
43//
44// Relationships
45// The single instance of this ME is associated with the ONU ME.
46//
47// Attributes
48// Managed Entity Id
49// Managed entity ID: This attribute uniquely identifies each instance of this ME. There is only
50// one instance, number 0. (R) (mandatory) (2-bytes)
51//
52// Olt Vendor Id
53// OLT vendor ID: This attribute identifies the OLT vendor. It is the same as the four most
54// significant bytes of an ONU serial number specified in the respective TC layer specification.
55// Upon instantiation, this attribute comprises all spaces. (R,-W) (mandatory) (4-bytes)
56//
57// Equipment Id
58// Equipment ID: This attribute may be used to identify the specific type of OLT. The default value
59// of all spaces indicates that equipment ID information is not available or applicable to the OLT
60// being represented. (R,-W) (mandatory) (20-bytes)
61//
62// Version
63// Version: This attribute identifies the version of the OLT as defined by the vendor. The default
64// left-justified ASCII string "0" (padded with trailing nulls) indicates that version information
65// is not available or applicable to the OLT being represented. (R,-W) (mandatory) (14-bytes)
66//
67// Time Of Day Information
68// NOTE - In ITU-T G.987/ITU-T G.989 systems, the superframe count field of the time of day
69// information attribute contains the 32 LSBs of the actual counter.
70//
71type OltG struct {
72 ManagedEntityDefinition
73 Attributes AttributeValueMap
74}
75
76func init() {
77 oltgBME = &ManagedEntityDefinition{
78 Name: "OltG",
79 ClassID: 131,
80 MessageTypes: mapset.NewSetWith(
81 Get,
82 Set,
83 ),
84 AllowedAttributeMask: 0xf000,
85 AttributeDefinitions: AttributeDefinitionMap{
86 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
87 1: MultiByteField("OltVendorId", StringAttributeType, 0x8000, 4, toOctets("ICAgIA=="), mapset.NewSetWith(Read, Write), false, false, false, 1),
88 2: MultiByteField("EquipmentId", StringAttributeType, 0x4000, 20, toOctets("ICAgICAgICAgICAgICAgICAgICA="), mapset.NewSetWith(Read, Write), false, false, false, 2),
89 3: MultiByteField("Version", StringAttributeType, 0x2000, 14, toOctets("MAAAAAAAAAAAAAAAAAA="), mapset.NewSetWith(Read, Write), false, false, false, 3),
90 4: MultiByteField("TimeOfDayInformation", OctetsAttributeType, 0x1000, 14, toOctets("AAAAAAAAAAAAAAAAAAA="), mapset.NewSetWith(Read, Write), false, true, false, 4),
91 },
92 Access: CreatedByOnu,
93 Support: UnknownSupport,
94 }
95}
96
97// NewOltG (class ID 131) creates the basic
98// Managed Entity definition that is used to validate an ME of this type that
99// is received from or transmitted to the OMCC.
100func NewOltG(params ...ParamData) (*ManagedEntity, OmciErrors) {
101 return NewManagedEntity(*oltgBME, params...)
102}