Source code for cfxdb.gen.meta.TagDefinition

# automatically generated by the FlatBuffers compiler, do not modify

# namespace: meta

import flatbuffers
from flatbuffers.compat import import_numpy


[docs]
np = import_numpy()



# Tag definitions are created independent of objects tagged with tags. Primary key of this table is ``oid``.

[docs]
class TagDefinition(object):

[docs]
    __slots__ = ["_tab"]


    @classmethod

[docs]
    def GetRootAs(cls, buf, offset=0):
        n = flatbuffers.encode.Get(flatbuffers.packer.uoffset, buf, offset)
        x = TagDefinition()
        x.Init(buf, n + offset)
        return x


    @classmethod

[docs]
    def GetRootAsTagDefinition(cls, buf, offset=0):
        """This method is deprecated. Please switch to GetRootAs."""
        return cls.GetRootAs(buf, offset)


    # TagDefinition

[docs]
    def Init(self, buf, pos):
        self._tab = flatbuffers.table.Table(buf, pos)


    # OID of the tag definition within the database.
    # TagDefinition

[docs]
    def Oid(self, j):
        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(4))
        if o != 0:
            a = self._tab.Vector(o)
            return self._tab.Get(
                flatbuffers.number_types.Uint8Flags, a + flatbuffers.number_types.UOffsetTFlags.py_type(j * 1)
            )
        return 0


    # TagDefinition

[docs]
    def OidAsNumpy(self):
        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(4))
        if o != 0:
            return self._tab.GetVectorAsNumpy(flatbuffers.number_types.Uint8Flags, o)
        return 0


    # TagDefinition

[docs]
    def OidLength(self):
        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(4))
        if o != 0:
            return self._tab.VectorLen(o)
        return 0


    # TagDefinition

[docs]
    def OidIsNone(self):
        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(4))
        return o == 0


    # Timestamp when the attribute was last modified (or first created).
    # TagDefinition

[docs]
    def Modified(self):
        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(6))
        if o != 0:
            return self._tab.Get(flatbuffers.number_types.Uint64Flags, o + self._tab.Pos)
        return 0


    # Tag name (or URI in general). This is must be globally unique and represents the semantic identifier of the tag.
    # TagDefinition

[docs]
    def Tag(self):
        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(8))
        if o != 0:
            return self._tab.String(o + self._tab.Pos)
        return None


    # CBOR-serialized, object-valued extra data stored along with this tag definition.
    # TagDefinition

[docs]
    def Extra(self, j):
        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(10))
        if o != 0:
            a = self._tab.Vector(o)
            return self._tab.Get(
                flatbuffers.number_types.Uint8Flags, a + flatbuffers.number_types.UOffsetTFlags.py_type(j * 1)
            )
        return 0


    # TagDefinition

[docs]
    def ExtraAsNumpy(self):
        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(10))
        if o != 0:
            return self._tab.GetVectorAsNumpy(flatbuffers.number_types.Uint8Flags, o)
        return 0


    # TagDefinition

[docs]
    def ExtraLength(self):
        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(10))
        if o != 0:
            return self._tab.VectorLen(o)
        return 0


    # TagDefinition

[docs]
    def ExtraIsNone(self):
        o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(10))
        return o == 0





[docs]
def TagDefinitionStart(builder):
    builder.StartObject(4)




[docs]
def Start(builder):
    TagDefinitionStart(builder)




[docs]
def TagDefinitionAddOid(builder, oid):
    builder.PrependUOffsetTRelativeSlot(0, flatbuffers.number_types.UOffsetTFlags.py_type(oid), 0)




[docs]
def AddOid(builder, oid):
    TagDefinitionAddOid(builder, oid)




[docs]
def TagDefinitionStartOidVector(builder, numElems):
    return builder.StartVector(1, numElems, 1)




[docs]
def StartOidVector(builder, numElems: int) -> int:
    return TagDefinitionStartOidVector(builder, numElems)




[docs]
def TagDefinitionAddModified(builder, modified):
    builder.PrependUint64Slot(1, modified, 0)




[docs]
def AddModified(builder, modified):
    TagDefinitionAddModified(builder, modified)




[docs]
def TagDefinitionAddTag(builder, tag):
    builder.PrependUOffsetTRelativeSlot(2, flatbuffers.number_types.UOffsetTFlags.py_type(tag), 0)




[docs]
def AddTag(builder, tag):
    TagDefinitionAddTag(builder, tag)




[docs]
def TagDefinitionAddExtra(builder, extra):
    builder.PrependUOffsetTRelativeSlot(3, flatbuffers.number_types.UOffsetTFlags.py_type(extra), 0)




[docs]
def AddExtra(builder, extra):
    TagDefinitionAddExtra(builder, extra)




[docs]
def TagDefinitionStartExtraVector(builder, numElems):
    return builder.StartVector(1, numElems, 1)




[docs]
def StartExtraVector(builder, numElems: int) -> int:
    return TagDefinitionStartExtraVector(builder, numElems)




[docs]
def TagDefinitionEnd(builder):
    return builder.EndObject()




[docs]
def End(builder):
    return TagDefinitionEnd(builder)