blob: 6c70980b828146ac398538e12c91a9f18e86ce26 [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// GemInterworkingTerminationPointClassID is the 16-bit ID for the OMCI
29// Managed entity GEM interworking termination point
30const GemInterworkingTerminationPointClassID ClassID = ClassID(266)
31
32var geminterworkingterminationpointBME *ManagedEntityDefinition
33
34// GemInterworkingTerminationPoint (class ID #266)
35// An instance of this ME represents a point in the ONU where the IW of a bearer service (usually
36// Ethernet) to the GEM layer takes place. At this point, GEM packets are generated from the bearer
37// bit stream (e.g., Ethernet) or the bearer bit stream is reconstructed from GEM packets.
38//
39// Instances of this ME are created and deleted by the OLT.
40//
41// Relationships
42// One instance of this ME exists for each transformation of a data stream into GEM frames and vice
43// versa.
44//
45// Attributes
46// Managed Entity Id
47// Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
48// (mandatory) (2-bytes)
49//
50// Gem Port Network Ctp Connectivity Pointer
51// GEM port network CTP connectivity pointer: This attribute points to an instance of the GEM port
52// network CTP. (R,-W, setbycreate) (mandatory) (2-bytes)
53//
54// Interworking Option
55// (R,-W, setbycreate) (mandatory) (1-byte)
56//
57// Service Profile Pointer
58// NOTE - The video return path (VRP) service profile is defined in [ITU-T G.984.4].
59//
60// Interworking Termination Point Pointer
61// In all other GEM services, the relationship between the related service TP and this GEM IW TP is
62// derived from other ME relations; this attribute is set to a null pointer and not used. (R,-W,
63// setbycreate) (mandatory) (2-bytes)
64//
65// Pptp Counter
66// PPTP counter: This value reports the number of PPTP ME instances associated with this GEM IW TP.
67// (R) (optional) (1-byte)
68//
69// Operational State
70// Operational state: This attribute indicates whether the ME is capable of performing its
71// function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)
72//
73// Gal Profile Pointer
74// (R,-W, setbycreate) (mandatory) (2-bytes)
75//
76// Gal Loopback Configuration
77// The default value of this attribute is 0. When the IW option is 6 (downstream broadcast), this
78// attribute is not used. (R,-W) (mandatory) (1-byte)
79//
80type GemInterworkingTerminationPoint struct {
81 ManagedEntityDefinition
82 Attributes AttributeValueMap
83}
84
85func init() {
86 geminterworkingterminationpointBME = &ManagedEntityDefinition{
87 Name: "GemInterworkingTerminationPoint",
88 ClassID: 266,
89 MessageTypes: mapset.NewSetWith(
90 Create,
91 Delete,
92 Get,
93 Set,
94 ),
95 AllowedAttributeMask: 0xff00,
96 AttributeDefinitions: AttributeDefinitionMap{
97 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
98 1: Uint16Field("GemPortNetworkCtpConnectivityPointer", PointerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
99 2: ByteField("InterworkingOption", EnumerationAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
100 3: Uint16Field("ServiceProfilePointer", PointerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 3),
101 4: Uint16Field("InterworkingTerminationPointPointer", PointerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 4),
102 5: ByteField("PptpCounter", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, true, false, 5),
103 6: ByteField("OperationalState", EnumerationAttributeType, 0x0400, 0, mapset.NewSetWith(Read), true, true, false, 6),
104 7: Uint16Field("GalProfilePointer", PointerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 7),
105 8: ByteField("GalLoopbackConfiguration", EnumerationAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), false, false, false, 8),
106 },
107 Access: CreatedByOlt,
108 Support: UnknownSupport,
109 }
110}
111
112// NewGemInterworkingTerminationPoint (class ID 266) creates the basic
113// Managed Entity definition that is used to validate an ME of this type that
114// is received from or transmitted to the OMCC.
115func NewGemInterworkingTerminationPoint(params ...ParamData) (*ManagedEntity, OmciErrors) {
116 return NewManagedEntity(*geminterworkingterminationpointBME, params...)
117}