tivars.flags.Enum

class documentation

class Enum(Converter['Enum'], IntEnum): (source)

Known subclasses: tivars.flash.DeviceType, tivars.types.gdb.BorderColor, tivars.types.gdb.GlobalLineStyle, tivars.types.gdb.GraphColor, tivars.types.gdb.GraphStyle

Constructor: Enum.get(data, **kwargs)

View In Hierarchy

Base class for enum types

This implementation subclasses Python's builtin IntEnum to interface with the Converter system.

Class Method get Converts bytes -> Enum, returning the first byte
Class Method set Converts Enum -> bytes, enforcing that the input is a recognized enum value
def get(cls, data: bytes, **kwargs) -> Enum: (source)
overrides tivars.data.Converter.get

Converts bytes -> Enum, returning the first byte

Parameters
data:bytesThe raw bytes to convert
**kwargsUndocumented
Returns
EnumThe first byte of data
def set(cls, value: Enum, **kwargs) -> bytes: (source)
overrides tivars.data.Converter.set

Converts Enum -> bytes, enforcing that the input is a recognized enum value

Parameters
value:EnumThe value to convert
**kwargsUndocumented
Returns
bytesThe byte in value, unchanged