tivars.types.settings.TIRecallWindow

class documentation

class TIRecallWindow(SettingsEntry): (source)

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

View In Hierarchy

Parser for recalled windows

A TIRecallWindow stores all plot window parameters as a contiguous stream of TIReal values.

Method __init__ Creates an empty entry with specified meta and data values
Method calc_data The data section of the entry which is loaded on-calc
Method dict No summary
Method name The name of the entry
Method nMax 𝑛Max: the final value of 𝑛 for sequential equations and plots
Method nMin 𝑛Min: the initial value of 𝑛 for sequential equations
Method PlotStart PlotStart: the initial value of 𝑛 for sequential plots
Method PlotStep PlotStep: the 𝑛 increment for sequential plots
Method Thetamax Θmax: the final angle for polar plots
Method Thetamin Θmin: the initial angle for polar plots
Method Thetastep Θstep: the angle increment for polar plots
Method Tmax Tmax: the final time for parametric plots
Method Tmin Tmin: the initial time for parametric plots
Method Tstep Tstep: the time increment for parametric plots
Method unMin0 u(𝑛Min): the initial value of u at 𝑛Min
Method unMin1 u(𝑛Min + 1): the initial value of u at 𝑛Min + 1
Method vnMin0 v(𝑛Min): the initial value of v at 𝑛Min
Method vnMin1 v(𝑛Min + 1): the initial value of v at 𝑛Min + 1
Method wnMin0 w(𝑛Min): the initial value of w at 𝑛Min
Method wnMin1 w(𝑛Min + 1): the initial value of w at 𝑛Min + 1
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 Xres Xres: the pixel separation of points in a function plot
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 min_data_length The minimum length of this entry's data
Class Variable _type_id Undocumented

Inherited from SettingsEntry:

Method __format__ Formats this entry for string representations
Method load_dict Loads a JSON dict into this settings entry
Method load_string Loads this entry from a string representation

Inherited from SizedEntry (via SettingsEntry):

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 SettingsEntry, 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 __iter__ No summary
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 coerce Coerces this entry to a subclass if possible using the entry's type ID
Method export Exports this entry to a TIVar with a specified name, header, and target model
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_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 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 leading_name_byte Byte that always begins the name of this entry
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 SettingsEntry, SizedEntry, TIEntry):

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, *, for_flash: bool = True, name: str = 'RclWindw', version: int = None, archived: bool = None, data: bytes = None): (source)
overrides tivars.var.TIEntry.__init__

Creates an empty entry with specified meta and data values

The entry version and archived flag are invalid if for_flash == False.

Parameters
initValues to initialize the entry's data (defaults to None)
for_flash:boolWhether the entry supports flash chips (defaults to True)
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 calc_data(self) -> bytes: (source)
overrides tivars.var.SizedEntry.calc_data

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

def dict(self) -> dict: (source)
overrides tivars.var.TIEntry.dict
Returns
dictA JSON dictionary representation of this entry
def name(self) -> str: (source)
overrides tivars.var.TIEntry.name

The name of the entry

This value is always RclWindw.

def nMax(self, value) -> GraphRealEntry: (source)

𝑛Max: the final value of 𝑛 for sequential equations and plots

The value must be an integer.

def nMin(self, value) -> GraphRealEntry: (source)

𝑛Min: the initial value of 𝑛 for sequential equations

The value must be an integer.

def PlotStart(self, value) -> GraphRealEntry: (source)

PlotStart: the initial value of 𝑛 for sequential plots

The value must be an integer.

def PlotStep(self, value) -> GraphRealEntry: (source)

PlotStep: the 𝑛 increment for sequential plots

The value must be an integer.

def Thetamax(self) -> GraphRealEntry: (source)

Θmax: the final angle for polar plots

def Thetamin(self) -> GraphRealEntry: (source)

Θmin: the initial angle for polar plots

def Thetastep(self) -> GraphRealEntry: (source)

Θstep: the angle increment for polar plots

def Tmax(self) -> GraphRealEntry: (source)

Tmax: the final time for parametric plots

def Tmin(self) -> GraphRealEntry: (source)

Tmin: the initial time for parametric plots

def Tstep(self) -> GraphRealEntry: (source)

Tstep: the time increment for parametric plots

def unMin0(self) -> GraphRealEntry: (source)

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

def unMin1(self) -> GraphRealEntry: (source)

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

def vnMin0(self) -> GraphRealEntry: (source)

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

def vnMin1(self) -> GraphRealEntry: (source)

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

def wnMin0(self) -> GraphRealEntry: (source)

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

def wnMin1(self) -> GraphRealEntry: (source)

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

def Xmax(self) -> GraphRealEntry: (source)

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

def Xmin(self) -> GraphRealEntry: (source)

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

def Xres(self, value) -> GraphRealEntry: (source)

Xres: the pixel separation of points in a function plot

The value must be an integer in [1,8].

def Xscl(self) -> GraphRealEntry: (source)

Xscl: the separation between ticks on the X-axis

def Ymax(self) -> GraphRealEntry: (source)

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

def Ymin(self) -> GraphRealEntry: (source)

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

def Yscl(self) -> GraphRealEntry: (source)

Yscl: the separation between ticks on the Y-axis

extensions = (source)
overrides tivars.var.TIEntry.extensions

The file extension used for this entry per-model

min_data_length: int = (source)
overrides tivars.types.settings.SettingsEntry.min_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

_type_id: int = (source)
overrides tivars.var.TIEntry._type_id

Undocumented