xref: /aosp_15_r20/external/flatbuffers/python/flatbuffers/reflection/Field.py (revision 890232f25432b36107d06881e0a25aaa6b473652) 
1# automatically generated by the FlatBuffers compiler, do not modify
2
3# namespace: reflection
4
5import flatbuffers
6from flatbuffers.compat import import_numpy
7np = import_numpy()
8
9class Field(object):
10    __slots__ = ['_tab']
11
12    @classmethod
13    def GetRootAs(cls, buf, offset=0):
14        n = flatbuffers.encode.Get(flatbuffers.packer.uoffset, buf, offset)
15        x = Field()
16        x.Init(buf, n + offset)
17        return x
18
19    @classmethod
20    def GetRootAsField(cls, buf, offset=0):
21        """This method is deprecated. Please switch to GetRootAs."""
22        return cls.GetRootAs(buf, offset)
23    @classmethod
24    def FieldBufferHasIdentifier(cls, buf, offset, size_prefixed=False):
25        return flatbuffers.util.BufferHasIdentifier(buf, offset, b"\x42\x46\x42\x53", size_prefixed=size_prefixed)
26
27    # Field
28    def Init(self, buf, pos):
29        self._tab = flatbuffers.table.Table(buf, pos)
30
31    # Field
32    def Name(self):
33        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(4))
34        if o != 0:
35            return self._tab.String(o + self._tab.Pos)
36        return None
37
38    # Field
39    def Type(self):
40        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(6))
41        if o != 0:
42            x = self._tab.Indirect(o + self._tab.Pos)
43            from reflection.Type import Type
44            obj = Type()
45            obj.Init(self._tab.Bytes, x)
46            return obj
47        return None
48
49    # Field
50    def Id(self):
51        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(8))
52        if o != 0:
53            return self._tab.Get(flatbuffers.number_types.Uint16Flags, o + self._tab.Pos)
54        return 0
55
56    # Field
57    def Offset(self):
58        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(10))
59        if o != 0:
60            return self._tab.Get(flatbuffers.number_types.Uint16Flags, o + self._tab.Pos)
61        return 0
62
63    # Field
64    def DefaultInteger(self):
65        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(12))
66        if o != 0:
67            return self._tab.Get(flatbuffers.number_types.Int64Flags, o + self._tab.Pos)
68        return 0
69
70    # Field
71    def DefaultReal(self):
72        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(14))
73        if o != 0:
74            return self._tab.Get(flatbuffers.number_types.Float64Flags, o + self._tab.Pos)
75        return 0.0
76
77    # Field
78    def Deprecated(self):
79        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(16))
80        if o != 0:
81            return bool(self._tab.Get(flatbuffers.number_types.BoolFlags, o + self._tab.Pos))
82        return False
83
84    # Field
85    def Required(self):
86        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(18))
87        if o != 0:
88            return bool(self._tab.Get(flatbuffers.number_types.BoolFlags, o + self._tab.Pos))
89        return False
90
91    # Field
92    def Key(self):
93        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(20))
94        if o != 0:
95            return bool(self._tab.Get(flatbuffers.number_types.BoolFlags, o + self._tab.Pos))
96        return False
97
98    # Field
99    def Attributes(self, j):
100        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(22))
101        if o != 0:
102            x = self._tab.Vector(o)
103            x += flatbuffers.number_types.UOffsetTFlags.py_type(j) * 4
104            x = self._tab.Indirect(x)
105            from reflection.KeyValue import KeyValue
106            obj = KeyValue()
107            obj.Init(self._tab.Bytes, x)
108            return obj
109        return None
110
111    # Field
112    def AttributesLength(self):
113        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(22))
114        if o != 0:
115            return self._tab.VectorLen(o)
116        return 0
117
118    # Field
119    def AttributesIsNone(self):
120        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(22))
121        return o == 0
122
123    # Field
124    def Documentation(self, j):
125        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(24))
126        if o != 0:
127            a = self._tab.Vector(o)
128            return self._tab.String(a + flatbuffers.number_types.UOffsetTFlags.py_type(j * 4))
129        return ""
130
131    # Field
132    def DocumentationLength(self):
133        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(24))
134        if o != 0:
135            return self._tab.VectorLen(o)
136        return 0
137
138    # Field
139    def DocumentationIsNone(self):
140        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(24))
141        return o == 0
142
143    # Field
144    def Optional(self):
145        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(26))
146        if o != 0:
147            return bool(self._tab.Get(flatbuffers.number_types.BoolFlags, o + self._tab.Pos))
148        return False
149
150    # Number of padding octets to always add after this field. Structs only.
151    # Field
152    def Padding(self):
153        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(28))
154        if o != 0:
155            return self._tab.Get(flatbuffers.number_types.Uint16Flags, o + self._tab.Pos)
156        return 0
157
158def FieldStart(builder): builder.StartObject(13)
159def Start(builder):
160    return FieldStart(builder)
161def FieldAddName(builder, name): builder.PrependUOffsetTRelativeSlot(0, flatbuffers.number_types.UOffsetTFlags.py_type(name), 0)
162def AddName(builder, name):
163    return FieldAddName(builder, name)
164def FieldAddType(builder, type): builder.PrependUOffsetTRelativeSlot(1, flatbuffers.number_types.UOffsetTFlags.py_type(type), 0)
165def AddType(builder, type):
166    return FieldAddType(builder, type)
167def FieldAddId(builder, id): builder.PrependUint16Slot(2, id, 0)
168def AddId(builder, id):
169    return FieldAddId(builder, id)
170def FieldAddOffset(builder, offset): builder.PrependUint16Slot(3, offset, 0)
171def AddOffset(builder, offset):
172    return FieldAddOffset(builder, offset)
173def FieldAddDefaultInteger(builder, defaultInteger): builder.PrependInt64Slot(4, defaultInteger, 0)
174def AddDefaultInteger(builder, defaultInteger):
175    return FieldAddDefaultInteger(builder, defaultInteger)
176def FieldAddDefaultReal(builder, defaultReal): builder.PrependFloat64Slot(5, defaultReal, 0.0)
177def AddDefaultReal(builder, defaultReal):
178    return FieldAddDefaultReal(builder, defaultReal)
179def FieldAddDeprecated(builder, deprecated): builder.PrependBoolSlot(6, deprecated, 0)
180def AddDeprecated(builder, deprecated):
181    return FieldAddDeprecated(builder, deprecated)
182def FieldAddRequired(builder, required): builder.PrependBoolSlot(7, required, 0)
183def AddRequired(builder, required):
184    return FieldAddRequired(builder, required)
185def FieldAddKey(builder, key): builder.PrependBoolSlot(8, key, 0)
186def AddKey(builder, key):
187    return FieldAddKey(builder, key)
188def FieldAddAttributes(builder, attributes): builder.PrependUOffsetTRelativeSlot(9, flatbuffers.number_types.UOffsetTFlags.py_type(attributes), 0)
189def AddAttributes(builder, attributes):
190    return FieldAddAttributes(builder, attributes)
191def FieldStartAttributesVector(builder, numElems): return builder.StartVector(4, numElems, 4)
192def StartAttributesVector(builder, numElems):
193    return FieldStartAttributesVector(builder, numElems)
194def FieldAddDocumentation(builder, documentation): builder.PrependUOffsetTRelativeSlot(10, flatbuffers.number_types.UOffsetTFlags.py_type(documentation), 0)
195def AddDocumentation(builder, documentation):
196    return FieldAddDocumentation(builder, documentation)
197def FieldStartDocumentationVector(builder, numElems): return builder.StartVector(4, numElems, 4)
198def StartDocumentationVector(builder, numElems):
199    return FieldStartDocumentationVector(builder, numElems)
200def FieldAddOptional(builder, optional): builder.PrependBoolSlot(11, optional, 0)
201def AddOptional(builder, optional):
202    return FieldAddOptional(builder, optional)
203def FieldAddPadding(builder, padding): builder.PrependUint16Slot(12, padding, 0)
204def AddPadding(builder, padding):
205    return FieldAddPadding(builder, padding)
206def FieldEnd(builder): return builder.EndObject()
207def End(builder):
208    return FieldEnd(builder)