tivars.types.gdb.TIGraphedEquation

class documentation

class TIGraphedEquation(TIEquation): (source)

Constructor: TIGraphedEquation(init, name, version, archived, data)

Parser for equations stored in GDBs

A TIGraphedEquation is a TIEquation with an extra leading flag byte. The equation's style and color in its GDB is bundled for convenience.

Class	`Raw`	Raw bytes container for `TIGraphedEquation`
Method	`__init__`	Creates an empty entry with specified meta and data values
Method	`__iter__`	No summary
Method	`calc_data`	The data section of the component which is loaded on-calc
Method	`coerce`	Coerces this component to a subclass if possible using the component's type ID
Method	`color`	The color of the GDB equation
Method	`data`	The component's user data
Method	`dict`	No summary
Method	`equation`	No summary
Method	`flags`	The flags for the GDB equation
Method	`length`	The length of this entry's user data section
Method	`load_data_section`	Loads the data of this entry from a bytestream
Method	`load_dict`	Loads a JSON `dict` into this GDB equation
Method	`load_equation`	Loads a `TIEquation` into this GDB equation
Method	`load_string`	Loads this entry from a string representation
Method	`style`	The style of the GDB equation
Class Variable	`min_calc_data_length`	The minimum length of this entry's data
Property	`is_defined`	Whether this GDB equation is undefined
Property	`json_name`	The name of this equation used in the GDB JSON format
Method	`__class_getitem__`	Undocumented

Inherited from TIEquation:

Method	`name`	The name of the entry
Class Variable	`extension`	The base file extension used for this entry
Class Variable	`leading_name_byte`	Byte that always begins the name of this entry
Class Variable	`_type_id`	Undocumented

Inherited from TokenizedEntry (via TIEquation):

Static Method	`decode`	Decodes a byte stream into a string of tokens
Static Method	`encode`	Encodes a string of token represented in text into a byte stream
Method	`__format__`	Undocumented
Method	`get_min_os`	Determines the minimum OS that supports this entry's data
Method	`get_version`	Determines the version byte corresponding to given data for this entry type
Method	`lines`	Splits this entry into logical lines: lines separated by newlines or colons lying outside string literals
Method	`load_bytes`	Loads a byte string or bytestream into this entry
Method	`load_tokens`	Loads this entry from a sequence of `TIToken` objects
Method	`string`	Decodes this entry into a string of tokens
Method	`tokens`	No summary
Class Variable	`clock_tokens`	Tokens which interface with the RTC
Class Variable	`versions`	The possible versions of this entry

Inherited from SizedEntry (via TIEquation, TokenizedEntry):

Method	`clear`	Clears this entry's data
Method	`get_length`	Determines the length of this entry's user data section

Inherited from TIEntry (via TIEquation, TokenizedEntry, SizedEntry):

Class Method	`get_extension`	Determines the file extension for a targeted model based on its contents
Class Method	`get_type`	Gets the subclass corresponding to a type ID, type name, or file extension if one is registered
Class Method	`open`	Creates a new entry from a file given a filename
Static Method	`next_entry_length`	Helper function to determine the length of the next entry in a bytestream
Method	`__len__`	No summary
Method	`archive`	Archives this entry
Method	`archived`	Whether the entry is archived
Method	`bytes`	The bytes contained in this entry, without any var file header or metadata.
Method	`export`	Exports this entry to a `TIVarFile` with a specified name and header
Method	`load_from_file`	Loads this entry from a file given a file pointer and offset
Method	`meta_length`	The length of the meta section of the entry
Method	`save`	Saves this entry as a var file in the current directory given a filename and optional header and targeted model
Method	`summary`	No summary
Method	`supported_by`	Determines whether a given model supports this entry
Method	`type_id`	The type ID of the entry
Method	`unarchive`	Unarchives this entry
Method	`version`	The version number of the entry
Class Variable	`base_meta_length`	Undocumented
Class Variable	`flash_meta_length`	Undocumented
Class Variable	`flash_only`	Whether this entry only supports flash chips
Class Variable	`leading_data_bytes`	Bytes that always begin this entry's data
Instance Variable	`raw`	Undocumented
Property	`calc_data_length`	The length of the data section of the entry
Property	`flash_bytes`	The flash bytes of this entry if they exist
Property	`for_flash`	Whether this entry supports flash chips
Property	`meta`	The meta section of this entry
Method	`__init_subclass__`	Undocumented
Class Variable	`_type_ids`	Undocumented

Inherited from TIComponent (via TIEquation, TokenizedEntry, SizedEntry, TIEntry):

Class Method	`get`	Converts `bytes` -> `TIComponent`
Class Method	`register`	Registers a subtype with this class for coercion
Class Method	`set`	Converts `TIComponent` -> `bytes`
Method	`__bool__`	No summary
Method	`__bytes__`	No summary
Method	`__copy__`	No summary
Method	`__eq__`	Determines if two components are the same type and have the same bytes
Method	`__str__`	No summary
Method	`json`	No summary
Method	`load_json`	Loads this component from a JSON dictionary representation
Method	`update`	Updates this component's metadata
Property	`is_empty`	Whether this component's data is empty

Inherited from Dock (via TIEquation, TokenizedEntry, SizedEntry, TIEntry, TIComponent):

Method	`load`	Loads data into an instance by delegating to `Loader` methods based on the input's type
Class Variable	`loaders`	Undocumented

def __init__(self, init=None, *, name: str = 'Y1', version: int = None, archived: bool = None, data: bytes = None): (source) ¶

overrides tivars.types.tokenized.TIEquation.__init__

Creates an empty entry with specified meta and data values

Parameters
init	Values to initialize the entry's data (defaults to `None`)
name:`str`	The name of the entry (defaults to a valid default name)
version:`int`	The entry's version (defaults to `None`)
archived:`bool`	Whether the entry is archived (defaults to entry's default state on-calc)
data:`bytes`	The entry's data (defaults to empty)

def __iter__(self) -> Iterator: (source) ¶

overrides tivars.types.tokenized.TokenizedEntry.__iter__

Returns
`Iterator`	If this entry is a container or collection, an iterator over its elements

@Section()

def calc_data(self) -> bytearray: (source) ¶

overrides tivars.var.SizedEntry.calc_data

The data section of the component which is loaded on-calc

def coerce(self): (source) ¶

overrides tivars.file.TIComponent.coerce

Coerces this component to a subclass if possible using the component's type ID

Valid types must be registered to be considered for coercion.

@Section(1, GraphColor)

def color(self) -> bytes: (source) ¶

The color of the GDB equation

This value is not intrinsically stored with the equation, but is bundled for convenience.

@View(calc_data, Data)[3:]

def data(self) -> bytes: (source) ¶

overrides tivars.var.SizedEntry.data

The component's user data

def dict(self, **kwargs) -> dict: (source) ¶

overrides tivars.var.TIEntry.dict

Returns
`dict`	A `dict` representing this GDB equation in JSON format

def equation(self) -> TIEquation: (source) ¶

Returns
`TIEquation`	The `TIEquation` component of this GDB equation

@View(calc_data, EquationFlags)[0:1]

def flags(self) -> EquationFlags: (source) ¶

The flags for the GDB equation

The flags track whether the equation is selected, used for graphing, or is participating in a link transfer.

@View(calc_data, Integer)[1:3]

def length(self) -> int: (source) ¶

overrides tivars.var.SizedEntry.length

The length of this entry's user data section

def load_data_section(self, data: BytesIO): (source) ¶

overrides tivars.var.SizedEntry.load_data_section

Loads the data of this entry from a bytestream

Parameters
data:`BytesIO`	The source bytes

@Loader[dict]

def load_dict(self, dct: dict, **kwargs): (source) ¶

overrides tivars.var.TIEntry.load_dict

Loads a JSON dict into this GDB equation

Parameters
dct:`dict`	The dict to load
**kwargs	Undocumented

@Loader[TIEquation]

def load_equation(self, equation: TIEquation): (source) ¶

Loads a TIEquation into this GDB equation

Parameters
equation:`TIEquation`	The equation to load

@Loader[str]

def load_string(self, string: str, *, model: TIModel = TI_84PCE, lang: str = None, mode: str = None): (source) ¶

overrides tivars.types.tokenized.TokenizedEntry.load_string

Loads this entry from a string representation

For detailed information on tokenization modes, see tivars.tokenizer.encode.

Parameters
string:`str`	The string to load
model:`TIModel`	The model to target when encoding (defaults to no specific model)
lang:`str`	The language used in `string` (defaults to English, `en`)
mode:`str`	The tokenization mode to use (defaults to `smart`)

@Section(1, GraphStyle)

def style(self) -> bytes: (source) ¶

The style of the GDB equation

This value is not intrinsically stored with the equation, but is bundled for convenience.

min_calc_data_length: int = (source) ¶

overrides tivars.types.tokenized.TokenizedEntry.min_calc_data_length

The minimum length of this entry's data

If an entry's data is fixed in size, this value is necessarily the length of the data

@property

is_defined: bool = (source) ¶

Whether this GDB equation is undefined

@property

json_name: str = (source) ¶

The name of this equation used in the GDB JSON format

def __class_getitem__(cls, index: int): (source) ¶

Undocumented