tivars.types.gdb.TIMonoSeqGDB

class documentation

class TIMonoSeqGDB(TIMonoGDB): (source)

Known subclasses: tivars.types.gdb.TISeqGDB

Constructor: TIMonoSeqGDB(init, for_flash, name, version, ...)

Parser for sequential GDBs

Method	`calc_data`	The data section of the entry which is loaded on-calc
Method	`dict`	No summary
Method	`load_dict`	Loads a JSON `dict` into this GDB
Method	`mode_id`	The mode ID for the GDB - `0x80`
Method	`nMax`	𝑛Max: The final value of 𝑛
Method	`nMin`	nMin: the initial value of 𝑛
Method	`PlotStart`	PlotStart: The initial value of 𝑛 for sequential plots
Method	`PlotStep`	PlotStep: The 𝑛 increment for sequential plots
Method	`sequence_flags`	The flags for the sequence mode settings
Method	`u`	u: The 1st equation in sequence mode
Method	`unMin`	u(𝑛Min): The initial value of u at 𝑛Min
Method	`unMinp1`	u(𝑛Min+1): The initial value of u at 𝑛Min + 1
Method	`v`	v: The 2nd equation in sequence mode
Method	`vnMin`	v(𝑛Min): The initial value of v at 𝑛Min
Method	`vnMinp1`	v(nMin+1): The initial value of v at 𝑛Min + 1
Method	`w`	w: The 3rd equation in sequence mode
Method	`wnMin`	w(𝑛Min): The initial value of w at 𝑛Min
Method	`wnMinp1`	w(𝑛Min+1): The initial value of w at 𝑛Min + 1
Class Variable	`equation_names`	The names of the equations in this GDB type
Class Variable	`min_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
Method	`_load_dict`	Undocumented

Inherited from TIMonoGDB:

Method	`__format__`	Formats this entry for string representations
Method	`__init__`	Creates an empty entry with specified meta and data values
Method	`__iter__`	No summary
Method	`coerce`	Coerces this entry to a subclass if possible using the entry's type ID
Method	`extended_mode_flags`	The flags for the extended mode settings
Method	`get_color_data`	Finds the color portion of a GDB if it exists
Method	`get_equations`	Extracts the equations stored in a GDB into a `tuple`
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_string`	Loads this entry from a string representation
Method	`mode_flags`	The flags for the mode settings
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	`extensions`	The file extension used for this entry per-model
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
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
Class Variable	`_type_id`	Undocumented

Inherited from SizedEntry (via TIMonoGDB):

Method	`clear`	Clears this entry's data
Method	`data`	The entry's user data
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 TIMonoGDB, SizedEntry):

Class	`Raw`	Raw bytes container for `TIEntry`
Class Method	`get`	Converts `bytes` -> `TIEntry`
Class Method	`get_type`	Gets the subclass corresponding to a type ID if one is registered
Class Method	`open`	Creates a new entry from a file given a filename
Class Method	`register`	Registers a subtype with this class for coercion
Class Method	`set`	Converts `TIEntry` -> `bytes`
Static Method	`next_entry_length`	Helper function to determine the length of the next entry in a bytestream
Method	`__bool__`	No summary
Method	`__bytes__`	No summary
Method	`__copy__`	No summary
Method	`__eq__`	Determines if two entries are the same type and have the same bytes
Method	`__len__`	No summary
Method	`__str__`	No summary
Method	`archive`	Archives this entry (if supported)
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 `TIVar` with a specified name, header, and target model
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	`string`	No summary
Method	`supported_by`	Determines whether a given model can support this entry
Method	`type_id`	The type ID of the entry
Method	`unarchive`	Unarchives this entry (if supported)
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	`is_empty`	Whether this entry's data is empty
Property	`meta`	The meta section of this entry
Method	`__init_subclass__`	Undocumented
Constant	`_T`	Undocumented
Class Variable	`_type_ids`	Undocumented

Inherited from Dock (via TIMonoGDB, SizedEntry, TIEntry):

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

@Section()
def calc_data(self) -> bytes: (source) ¶

overrides tivars.types.gdb.TIMonoGDB.calc_data

overridden in tivars.types.gdb.TISeqGDB

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

def dict(self) -> dict: (source) ¶

overrides tivars.types.gdb.TIMonoGDB.dict

overridden in tivars.types.gdb.TISeqGDB

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

@Loader[dict]
def load_dict(self, dct: dict = None): (source) ¶

overrides tivars.types.gdb.TIMonoGDB.load_dict

Loads a JSON dict into this GDB

Parameters
dct:`dict`	The dict to load

@View(calc_data, Integer)[3:4]
def mode_id(self) -> int: (source) ¶

overrides tivars.types.gdb.TIMonoGDB.mode_id

The mode ID for the GDB - 0x80

@View(calc_data, GraphRealEntry)[70:79]
def nMax(self, value) -> GraphRealEntry: (source) ¶

𝑛Max: The final value of 𝑛

The value must be an integer.

@View(calc_data, GraphRealEntry)[97:106]
def nMin(self, value) -> GraphRealEntry: (source) ¶

nMin: the initial value of 𝑛

The value must be an integer.

@View(calc_data, GraphRealEntry)[61:70]
def PlotStart(self, value) -> GraphRealEntry: (source) ¶

PlotStart: The initial value of 𝑛 for sequential plots

The value must be an integer.

@View(calc_data, GraphRealEntry)[133:142]
def PlotStep(self, value) -> GraphRealEntry: (source) ¶

PlotStep: The 𝑛 increment for sequential plots

The value must be an integer.

@View(calc_data, GraphMode)[5:6]
def sequence_flags(self) -> SeqMode: (source) ¶

The flags for the sequence mode settings

@View(calc_data, TIGraphedEquation[1])
def u(self) -> TIGraphedEquation: (source) ¶

u: The 1st equation in sequence mode

@View(calc_data, GraphRealEntry)[79:88]
def unMin(self) -> GraphRealEntry: (source) ¶

u(𝑛Min): The initial value of u at 𝑛Min

@View(calc_data, GraphRealEntry)[106:115]
def unMinp1(self) -> GraphRealEntry: (source) ¶

u(𝑛Min+1): The initial value of u at 𝑛Min + 1

@View(calc_data, TIGraphedEquation[2])
def v(self) -> TIGraphedEquation: (source) ¶

v: The 2nd equation in sequence mode

@View(calc_data, GraphRealEntry)[88:97]
def vnMin(self) -> GraphRealEntry: (source) ¶

v(𝑛Min): The initial value of v at 𝑛Min

@View(calc_data, GraphRealEntry)[115:124]
def vnMinp1(self) -> GraphRealEntry: (source) ¶

v(nMin+1): The initial value of v at 𝑛Min + 1

@View(calc_data, TIGraphedEquation[3])
def w(self) -> TIGraphedEquation: (source) ¶

w: The 3rd equation in sequence mode

@View(calc_data, GraphRealEntry)[124:133]
def wnMin(self) -> GraphRealEntry: (source) ¶

w(𝑛Min): The initial value of w at 𝑛Min

@View(calc_data, GraphRealEntry)[142:151]
def wnMinp1(self) -> GraphRealEntry: (source) ¶

w(𝑛Min+1): The initial value of w at 𝑛Min + 1

equation_names: list[str] = (source) ¶

overrides tivars.types.gdb.TIMonoGDB.equation_names

The names of the equations in this GDB type

min_data_length: int = (source) ¶

overrides tivars.types.gdb.TIMonoGDB.min_data_length

overridden in tivars.types.gdb.TISeqGDB

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) ¶

overrides tivars.types.gdb.TIMonoGDB.mode_byte

The byte which identifies the GDB type

num_equations: int = (source) ¶

overrides tivars.types.gdb.TIMonoGDB.num_equations

The number of equations contained in this GDB type

num_parameters: int = (source) ¶

overrides tivars.types.gdb.TIMonoGDB.num_parameters

The number of graph parameters contained in this GDB type

num_styles: int = (source) ¶

overrides tivars.types.gdb.TIMonoGDB.num_styles

The number of equation styles contained in this GDB type

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

overrides tivars.types.gdb.TIMonoGDB._load_dict

overridden in tivars.types.gdb.TISeqGDB

Undocumented