tivars.types.gdb.TIMonoGDB

class documentation

class TIMonoGDB(SizedEntry): (source)

Known subclasses: tivars.types.gdb.TIGDB, tivars.types.gdb.TIMonoFuncGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoPolarGDB, tivars.types.gdb.TIMonoSeqGDB

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

View In Hierarchy

Base class for all GDB entries

A GDB is a collection of equations and graph settings representing the state of one of the equation plotters. A GDB can correspond to one of the Function, Parametric, Polar, or Sequence plotting modes. GDBs for monochrome models are truncations of those for color models.

Method	`__format__`	Undocumented
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	`clear`	Clears this entry's data
Method	`coerce`	Coerces this component to a subclass if possible using the component's type ID
Method	`dict`	No summary
Method	`extended_mode_flags`	The flags for the extended mode settings
Method	`get_color_data`	Finds the color portion of this GDB if it exists
Method	`get_equations`	Extracts the equations stored in this GDB
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	`load_dict`	Loads a JSON `dict` into this GDB
Method	`load_string`	Loads this component from a string representation
Method	`mode_flags`	The flags for the mode settings
Method	`mode_id`	The mode ID for the GDB
Method	`summary`	No summary
Method	`Xmax`	Xmax: the X-coordinate of the right edge of the graphscreen
Method	`Xmin`	Xmin: the X-coordinate of the left edge of the graphscreen
Method	`Xscl`	Xscl: the separation between ticks on the X-axis
Method	`Ymax`	Ymax: the Y-coordinate of the top edge of the graphscreen
Method	`Ymin`	Ymin: the Y-coordinate of the bottom edge of the graphscreen
Method	`Yscl`	Yscl: the separation between ticks on the Y-axis
Class Variable	`equation_names`	The names of the equations in this GDB type
Class Variable	`extension`	The base file extension used for this entry
Class Variable	`has_color`	Whether this GDB type carries color information
Class Variable	`leading_name_byte`	Byte that always begins the name of this entry
Class Variable	`min_calc_data_length`	The minimum length of this entry's data
Class Variable	`mode_byte`	The byte which identifies the GDB type
Class Variable	`num_equations`	The number of equations contained in this GDB type
Class Variable	`num_parameters`	The number of graph parameters contained in this GDB type
Class Variable	`num_styles`	The number of equation styles contained in this GDB type
Property	`equations`	This GDB's stored equations
Property	`mode`	The mode for the GDB
Property	`offset`	The index of the start of the equation styles in this GDB's data
Method	`_load_dict`	Undocumented
Class Variable	`_type_id`	Undocumented

Inherited from SizedEntry:

Method	`data`	The component's user data
Method	`get_length`	Determines the length of this entry's user data section
Method	`length`	The length of this entry's user data section
Method	`load_bytes`	Loads a byte string or bytestream into this entry
Method	`load_data_section`	Loads the data of this entry from a bytestream

Inherited from TIEntry (via SizedEntry):

Class	`Raw`	No class docstring; 3/3 properties, 0/1 class variable, 1/1 method documented
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	`name`	The name 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	`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
Class Variable	`versions`	The possible versions of this entry
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 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	`string`	No summary
Method	`update`	Updates this component's metadata
Property	`is_empty`	Whether this component's data is empty

Inherited from Dock (via 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 __format__(self, format_spec: str) -> str: (source) ¶

overrides tivars.file.TIComponent.__format__

Undocumented

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

overrides tivars.var.TIEntry.__init__

overridden in tivars.types.gdb.TIGDB

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.var.TIEntry.__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

overridden in tivars.types.gdb.TIGDB, tivars.types.gdb.TIMonoFuncGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoPolarGDB, tivars.types.gdb.TIMonoSeqGDB

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

def clear(self): (source) ¶

overrides tivars.var.SizedEntry.clear

Clears this entry's data

def coerce(self): (source) ¶

overrides tivars.file.TIComponent.coerce

overridden in tivars.types.gdb.TIGDB

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

Valid types must be registered to be considered for coercion.

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

overrides tivars.var.TIEntry.dict

overridden in tivars.types.gdb.TIGDB, tivars.types.gdb.TIMonoFuncGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoPolarGDB, tivars.types.gdb.TIMonoSeqGDB

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

@View(calc_data, GraphMode)[6:7]

def extended_mode_flags(self) -> GraphMode: (source) ¶

The flags for the extended mode settings

ExprOn/Off and sequence plot offsets for sequence mode

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

Finds the color portion of this GDB if it exists

Returns
`bytes`	The color portion of this GDB, which may be empty

def get_equations(self) -> tuple[TIGraphedEquation, ...]: (source) ¶

Extracts the equations stored in this GDB

Returns
`tuple[TIGraphedEquation, ...]`	A `tuple` of equations stored in this GDB

def get_min_os(self) -> OsVersion: (source) ¶

overrides tivars.var.TIEntry.get_min_os

Determines the minimum OS that supports this entry's data

Returns
`OsVersion`	The minimum `OsVersion` this entry supports

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

overrides tivars.var.TIEntry.get_version

Determines the version byte corresponding to given data for this entry type

Entries which could contain non-backwards compatible data are assigned a version byte. If an entry's version exceeds the "version" of a calculator, transfer to the calculator will fail.

Returns
`int`	The version byte for this entry

@Loader[dict]

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

overrides tivars.var.TIEntry.load_dict

Loads a JSON dict into this GDB

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

@Loader[str]

def load_string(self, string: str, **kwargs): (source) ¶

overrides tivars.file.TIComponent.load_string

Loads this component from a string representation

If there is no dedicated handler for a component type, all subclasses of the type will be considered.

Parameters
string:`str`	The string to load
**kwargs	Undocumented

@View(calc_data, GraphMode)[4:5]

def mode_flags(self) -> GraphMode: (source) ¶

The flags for the mode settings

Dot/Connected, Simul/Sequential, GridOn/Line/Dot/Off, PolarGC/RectGC, CoordOn/Off, AxesOff/On, and LabelOn/Off

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

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

overridden in tivars.types.gdb.TIMonoFuncGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoPolarGDB, tivars.types.gdb.TIMonoSeqGDB

The mode ID for the GDB

The ID is one of 0x10 (Function), 0x20 (Polar), 0x40 (Parametric), or 0x80 (Sequence).

def summary(self) -> str: (source) ¶

overrides tivars.var.TIEntry.summary

overridden in tivars.types.gdb.TIGDB

Returns
`str`	A text summary of this component

@View(calc_data, RealEntry)[16:25]

def Xmax(self) -> RealEntry: (source) ¶

Xmax: the X-coordinate of the right edge of the graphscreen

@View(calc_data, RealEntry)[7:16]

def Xmin(self) -> RealEntry: (source) ¶

Xmin: the X-coordinate of the left edge of the graphscreen

@View(calc_data, RealEntry)[25:34]

def Xscl(self) -> RealEntry: (source) ¶

Xscl: the separation between ticks on the X-axis

@View(calc_data, RealEntry)[43:52]

def Ymax(self) -> RealEntry: (source) ¶

Ymax: the Y-coordinate of the top edge of the graphscreen

@View(calc_data, RealEntry)[34:43]

def Ymin(self) -> RealEntry: (source) ¶

Ymin: the Y-coordinate of the bottom edge of the graphscreen

@View(calc_data, RealEntry)[52:61]

def Yscl(self) -> RealEntry: (source) ¶

Yscl: the separation between ticks on the Y-axis

equation_names: list[str] = (source) ¶

overridden in tivars.types.gdb.TIMonoFuncGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoPolarGDB, tivars.types.gdb.TIMonoSeqGDB

The names of the equations in this GDB type

extension: str = (source) ¶

overrides tivars.var.TIEntry.extension

The base file extension used for this entry

has_color: bool = (source) ¶

overridden in tivars.types.gdb.TIGDB

Whether this GDB type carries color information

leading_name_byte: bytes = (source) ¶

overrides tivars.var.TIEntry.leading_name_byte

Byte that always begins the name of this entry

min_calc_data_length: int = (source) ¶

overrides tivars.var.SizedEntry.min_calc_data_length

overridden in tivars.types.gdb.TIGDB, tivars.types.gdb.TIMonoFuncGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoPolarGDB, tivars.types.gdb.TIMonoSeqGDB

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

mode_byte: int = (source) ¶

overridden in tivars.types.gdb.TIMonoFuncGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoPolarGDB, tivars.types.gdb.TIMonoSeqGDB

The byte which identifies the GDB type

num_equations: int = (source) ¶

overridden in tivars.types.gdb.TIMonoFuncGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoPolarGDB, tivars.types.gdb.TIMonoSeqGDB

The number of equations contained in this GDB type

num_parameters: int = (source) ¶

overridden in tivars.types.gdb.TIMonoFuncGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoPolarGDB, tivars.types.gdb.TIMonoSeqGDB

The number of graph parameters contained in this GDB type

num_styles: int = (source) ¶

overridden in tivars.types.gdb.TIMonoFuncGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoPolarGDB, tivars.types.gdb.TIMonoSeqGDB

The number of equation styles contained in this GDB type

@property

equations: tuple[TIGraphedEquation, ...] = (source) ¶

This GDB's stored equations

@property

mode: str | None = (source) ¶

The mode for the GDB

One of Function, Parametric, Polar, or Sequence

@property

offset: int = (source) ¶

The index of the start of the equation styles in this GDB's data

def _load_dict(self, dct: dict): (source) ¶

overridden in tivars.types.gdb.TIFuncGDB, tivars.types.gdb.TIGDB, tivars.types.gdb.TIMonoParamGDB, tivars.types.gdb.TIMonoSeqGDB, tivars.types.gdb.TIPolarGDB

Undocumented

_type_id: int = (source) ¶

overrides tivars.file.TIComponent._type_id

Undocumented