tivars.types.gdb.TIGDB

class documentation

class TIGDB(TIMonoGDB): (source)

Known subclasses: tivars.types.gdb.TIFuncGDB, tivars.types.gdb.TIParamGDB, tivars.types.gdb.TIPolarGDB, tivars.types.gdb.TISeqGDB

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

View In Hierarchy

Base class for all color 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.

Method __init__ Creates an empty entry with specified meta and data values
Method axes_color The color of the axes
Method border_color The color of the graph border
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_mode_flags The flags for extended color mode settings
Method dict No summary
Method global_line_style The line style for all plotted equations
Method grid_color The color of the grid
Method summary No summary
Class Variable has_color Whether this GDB type carries color information
Class Variable min_calc_data_length The minimum length of this entry's data
Instance Variable color_magic Undocumented
Method _load_dict Undocumented

Inherited from TIMonoGDB:

Method __format__ Undocumented
Method __iter__ No summary
Method clear Clears this entry's data
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 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 leading_name_byte Byte that always begins the name of this entry
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
Class Variable _type_id Undocumented

Inherited from SizedEntry (via TIMonoGDB):

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 TIMonoGDB, 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 TIMonoGDB, 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 TIMonoGDB, 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 = 'GDB1', version: int = None, archived: bool = None, data: bytes = None): (source)
overrides tivars.types.gdb.TIMonoGDB.__init__

Creates an empty entry with specified meta and data values

Parameters
initValues to initialize the entry's data (defaults to None)
name:strThe name of the entry (defaults to a valid default name)
version:intThe entry's version (defaults to None)
archived:boolWhether the entry is archived (defaults to entry's default state on-calc)
data:bytesThe entry's data (defaults to empty)
def axes_color(self) -> bytes: (source)

The color of the axes

def border_color(self) -> bytes: (source)

The color of the graph border

def calc_data(self) -> bytearray: (source)
overrides tivars.types.gdb.TIMonoGDB.calc_data
overridden in tivars.types.gdb.TIFuncGDB, tivars.types.gdb.TIParamGDB, tivars.types.gdb.TIPolarGDB, tivars.types.gdb.TISeqGDB

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

def coerce(self): (source)
overrides tivars.types.gdb.TIMonoGDB.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.

def color_mode_flags(self) -> GraphMode: (source)

The flags for extended color mode settings

Only DetectAsymptotesOn/Off is stored here.

def dict(self, **kwargs) -> dict: (source)
overrides tivars.types.gdb.TIMonoGDB.dict
overridden in tivars.types.gdb.TIFuncGDB, tivars.types.gdb.TIParamGDB, tivars.types.gdb.TIPolarGDB, tivars.types.gdb.TISeqGDB
Returns
dictA dict representing this GDB in JSON format
def global_line_style(self) -> bytes: (source)

The line style for all plotted equations

def grid_color(self) -> bytes: (source)

The color of the grid

def summary(self) -> str: (source)
overrides tivars.types.gdb.TIMonoGDB.summary
Returns
strA text summary of this component
has_color: bool = (source)
overrides tivars.types.gdb.TIMonoGDB.has_color

Whether this GDB type carries color information

min_calc_data_length: int = (source)
overrides tivars.types.gdb.TIMonoGDB.min_calc_data_length
overridden in tivars.types.gdb.TIFuncGDB, tivars.types.gdb.TIParamGDB, tivars.types.gdb.TIPolarGDB, 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

color_magic: str = (source)
overridden in tivars.types.gdb.TIFuncGDB, tivars.types.gdb.TIParamGDB, tivars.types.gdb.TIPolarGDB, tivars.types.gdb.TISeqGDB

Undocumented

def _load_dict(self, dct: dict): (source)
overrides tivars.types.gdb.TIMonoGDB._load_dict
overridden in tivars.types.gdb.TIFuncGDB, tivars.types.gdb.TIParamGDB, tivars.types.gdb.TIPolarGDB, tivars.types.gdb.TISeqGDB

Undocumented