Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net) |
Andrea Campanella | 7167ebb | 2020-02-24 09:56:38 +0100 | [diff] [blame] | 3 | * Copyright 2020-present Open Networking Foundation |
| 4 | |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 5 | * 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 Campanella | 7167ebb | 2020-02-24 09:56:38 +0100 | [diff] [blame] | 8 | |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
Andrea Campanella | 7167ebb | 2020-02-24 09:56:38 +0100 | [diff] [blame] | 10 | |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 11 | * 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 | */ |
David K. Bainbridge | adf422d | 2021-04-09 16:06:41 +0000 | [diff] [blame^] | 17 | /* |
Chip Boling | 6e27b35 | 2020-02-14 09:10:01 -0600 | [diff] [blame] | 18 | * 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 | |
| 24 | package generated |
| 25 | |
| 26 | import "github.com/deckarep/golang-set" |
| 27 | |
| 28 | // PseudowireMaintenanceProfileClassID is the 16-bit ID for the OMCI |
| 29 | // Managed entity Pseudowire maintenance profile |
| 30 | const PseudowireMaintenanceProfileClassID ClassID = ClassID(284) |
| 31 | |
| 32 | var pseudowiremaintenanceprofileBME *ManagedEntityDefinition |
| 33 | |
| 34 | // PseudowireMaintenanceProfile (class ID #284) |
| 35 | // The pseudowire maintenance profile permits the configuration of pseudowire service exception |
| 36 | // handling. It is created and deleted by the OLT. |
| 37 | // |
| 38 | // The settings, and indeed existence, of a pseudowire maintenance profile affect the behaviour of |
| 39 | // the pseudowire PM history data ME only in establishing criteria for counting SESs, but in no |
| 40 | // other way. The pseudowire maintenance profile primarily affects the alarms declared by the |
| 41 | // subscribing pseudowire TP. |
| 42 | // |
| 43 | // Relationships |
| 44 | // One or more instances of the pseudowire TP may point to an instance of the pseudowire |
| 45 | // maintenance profile. If the pseudowire TP does not refer to a pseudowire maintenance profile, |
| 46 | // the ONU's default exception handling is implied. |
| 47 | // |
| 48 | // Attributes |
| 49 | // Managed Entity Id |
| 50 | // Managed entity ID: This attribute uniquely identifies each instance of this ME. The value 0 is |
| 51 | // reserved. (R, setbycreate) (mandatory) (2-bytes) |
| 52 | // |
| 53 | // Jitter Buffer Maximum Depth |
| 54 | // Jitter buffer maximum depth: This attribute specifies the desired maximum depth of the playout |
| 55 | // buffer in the PSN to the TDM direction. The value is expressed as a multiple of the 125-vs frame |
| 56 | // rate. The default value 0 selects the ONU's internal policy. (R,-W, setbycreate) (optional) |
| 57 | // (2-bytes) |
| 58 | // |
| 59 | // Jitter Buffer Desired Depth |
| 60 | // Jitter buffer desired depth: This attribute specifies the desired nominal fill depth of the |
| 61 | // playout buffer in the PSN to the TDM direction. The value is expressed as a multiple of the |
| 62 | // 125-vs frame rate. The default value 0 selects the ONU's internal policy. (R,-W, setbycreate) |
| 63 | // (optional) (2-bytes) |
| 64 | // |
| 65 | // Fill Policy |
| 66 | // (R,-W, setbycreate) (optional) (1-byte) |
| 67 | // |
| 68 | // Misconnected Packets Declaration Policy |
| 69 | // Misconnected packets declaration policy: (R,-W, setbycreate) (optional) (1-byte) |
| 70 | // |
| 71 | // Misconnected Packets Clear Policy |
| 72 | // Misconnected packets clear policy: (R,-W, setbycreate) (optional) (1-byte) |
| 73 | // |
| 74 | // Loss Of Packets Declaration Policy |
| 75 | // Loss of packets declaration policy: (R,-W, setbycreate) (optional) (1-byte) |
| 76 | // |
| 77 | // Loss Of Packets Clear Policy |
| 78 | // Loss of packets clear policy: (R,-W, setbycreate) (optional) (1-byte) |
| 79 | // |
| 80 | // Buffer Overrun_Underrun Declaration Policy |
| 81 | // Buffer overrun/underrun declaration policy: (R,-W, setbycreate) (optional) (1-byte) |
| 82 | // |
| 83 | // Buffer Overrun_Underrun Clear Policy |
| 84 | // Buffer overrun/underrun clear policy: (R,-W, setbycreate) (optional) (1-byte) |
| 85 | // |
| 86 | // Malformed Packets Declaration Policy |
| 87 | // Malformed packets declaration policy: (R,-W, setbycreate) (optional) (1-byte) |
| 88 | // |
| 89 | // Malformed Packets Clear Policy |
| 90 | // Malformed packets clear policy: (R,-W, setbycreate) (optional) (1-byte) |
| 91 | // |
| 92 | // R_Bit Transmit Set Policy |
| 93 | // R-bit transmit set policy: This attribute defines the number of consecutive lost packets that |
| 94 | // causes the transmitted R bit to be set in the TDM to the PSN direction, indicating lost packets |
| 95 | // to the far end. The default value 0 selects the ONU's internal policy. (R,-W, setbycreate) |
| 96 | // (optional) (1-byte) |
| 97 | // |
| 98 | // R_Bit Transmit Clear Policy |
| 99 | // R-bit transmit clear policy: This attribute defines the number of consecutive valid packets that |
| 100 | // causes the transmitted R bit to be cleared in the TDM to the PSN direction, removing the remote |
| 101 | // failure indication to the far end. The default value 0 selects the ONU's internal policy. (R,-W, |
| 102 | // setbycreate) (optional) (1-byte) |
| 103 | // |
| 104 | // R_Bit Receive Policy |
| 105 | // (R,-W, setbycreate) (optional) (1-byte) |
| 106 | // |
| 107 | // L Bit Receive Policy |
| 108 | // (R,-W, setbycreate) (optional) (1-byte) |
| 109 | // |
| 110 | // Ses Threshold |
| 111 | // SES threshold: Number of lost, malformed or otherwise unusable packets expected in the PSN to |
| 112 | // the TDM direction within a 1-s interval that causes an SES to be counted. Stray packets do not |
| 113 | // count towards an SES, nor do packets whose L bit is set at the far end. The value 0 specifies |
| 114 | // that the ONU uses its internal default, which is not necessarily the same as the recommended |
| 115 | // default value 3. (R, W, set-by-create) (optional) (2 bytes) |
| 116 | // |
| 117 | type PseudowireMaintenanceProfile struct { |
| 118 | ManagedEntityDefinition |
| 119 | Attributes AttributeValueMap |
| 120 | } |
| 121 | |
| 122 | func init() { |
| 123 | pseudowiremaintenanceprofileBME = &ManagedEntityDefinition{ |
| 124 | Name: "PseudowireMaintenanceProfile", |
| 125 | ClassID: 284, |
| 126 | MessageTypes: mapset.NewSetWith( |
| 127 | Create, |
| 128 | Delete, |
| 129 | Get, |
| 130 | Set, |
| 131 | ), |
| 132 | AllowedAttributeMask: 0xffff, |
| 133 | AttributeDefinitions: AttributeDefinitionMap{ |
| 134 | 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0), |
| 135 | 1: Uint16Field("JitterBufferMaximumDepth", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 1), |
| 136 | 2: Uint16Field("JitterBufferDesiredDepth", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 2), |
| 137 | 3: ByteField("FillPolicy", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 3), |
| 138 | 4: ByteField("MisconnectedPacketsDeclarationPolicy", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 4), |
| 139 | 5: ByteField("MisconnectedPacketsClearPolicy", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 5), |
| 140 | 6: ByteField("LossOfPacketsDeclarationPolicy", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 6), |
| 141 | 7: ByteField("LossOfPacketsClearPolicy", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 7), |
| 142 | 8: ByteField("BufferOverrunUnderrunDeclarationPolicy", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 8), |
| 143 | 9: ByteField("BufferOverrunUnderrunClearPolicy", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 9), |
| 144 | 10: ByteField("MalformedPacketsDeclarationPolicy", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 10), |
| 145 | 11: ByteField("MalformedPacketsClearPolicy", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 11), |
| 146 | 12: ByteField("RBitTransmitSetPolicy", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 12), |
| 147 | 13: ByteField("RBitTransmitClearPolicy", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 13), |
| 148 | 14: ByteField("RBitReceivePolicy", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 14), |
| 149 | 15: ByteField("LBitReceivePolicy", UnsignedIntegerAttributeType, 0x0002, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 15), |
| 150 | 16: Uint16Field("SesThreshold", UnsignedIntegerAttributeType, 0x0001, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 16), |
| 151 | }, |
| 152 | Access: CreatedByOlt, |
| 153 | Support: UnknownSupport, |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | // NewPseudowireMaintenanceProfile (class ID 284) creates the basic |
| 158 | // Managed Entity definition that is used to validate an ME of this type that |
| 159 | // is received from or transmitted to the OMCC. |
| 160 | func NewPseudowireMaintenanceProfile(params ...ParamData) (*ManagedEntity, OmciErrors) { |
| 161 | return NewManagedEntity(*pseudowiremaintenanceprofileBME, params...) |
| 162 | } |