class TIGraphedEquation(TIEquation): (source)
Constructor: TIGraphedEquation(init, for_flash, name, version, ...)
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 bytes container for TIGraphedEquation |
Method | __init__ |
Creates an empty entry with specified meta and data values |
Method | __iter__ |
No summary |
Method | calc |
The data section of the entry which is loaded on-calc |
Method | coerce |
Coerces this entry to a subclass if possible using the entry's type ID |
Method | color |
The color of the GDB equation |
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 |
Loads the data of this entry from a bytestream |
Method | load |
Loads a JSON dict into this GDB equation |
Method | load |
Loads a TIEquation into this GDB equation |
Method | load |
Loads this entry from a string representation |
Method | style |
The style of the GDB equation |
Class Variable | min |
The minimum length of this entry's data |
Property | json |
The name of this equation used in the GDB JSON format |
Method | __class |
Undocumented |
Inherited from TIEquation
:
Method | name |
The name of the entry |
Class Variable | extensions |
The file extension used for this entry per-model |
Class Variable | leading |
Byte that always begins the name of this entry |
Class Variable | _type |
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__ |
Formats this entry for string representations |
Method | get |
Determines the minimum OS that supports this entry's data |
Method | get |
Determines the version byte corresponding to given data for this entry type |
Method | load |
Loads a byte string or bytestream into this entry |
Method | load |
Loads this entry from a sequence of Token objects |
Method | tokens |
No summary |
Class Variable | clock |
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 | data |
The entry's user data |
Inherited from TIEntry
(via TIEquation
, TokenizedEntry
, SizedEntry
):
Class Method | get |
Converts bytes -> TIEntry |
Class Method | get |
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 |
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 |
Loads this entry from a file given a file pointer and offset |
Method | meta |
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 |
Determines whether a given model can support this entry |
Method | type |
The type ID of the entry |
Method | unarchive |
Unarchives this entry (if supported) |
Method | version |
The version number of the entry |
Class Variable | base |
Undocumented |
Class Variable | flash |
Undocumented |
Class Variable | flash |
Whether this entry only supports flash chips |
Class Variable | leading |
Bytes that always begin this entry's data |
Instance Variable | raw |
Undocumented |
Property | calc |
The length of the data section of the entry |
Property | flash |
The flash bytes of this entry if they exist |
Property | is |
Whether this entry's data is empty |
Property | meta |
The meta section of this entry |
Method | __init |
Undocumented |
Constant | _T |
Undocumented |
Class Variable | _type |
Undocumented |
Inherited from Dock
(via TIEquation
, TokenizedEntry
, SizedEntry
, TIEntry
):
Method | load |
Loads data into an instance by delegating to Loader methods based on the input's type |
Class Variable | loaders |
Undocumented |
bool
= True, name: str
= 'Y1', version: int
= None, archived: bool
= None, data: bytes
= None):
(source)
¶
Creates an empty entry with specified meta and data values
The entry version and archived flag are invalid if for_flash == False.
Parameters | |
init | Values to initialize the entry's data (defaults to None) |
forbool | Whether the entry supports flash chips (defaults to True) |
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) |
tivars.var.TIEntry.__iter__
Returns | |
Iterator | If this entry is a container or collection, an iterator over its elements |
tivars.var.TIEntry.coerce
Coerces this entry to a subclass if possible using the entry's type ID
Valid types must be registered to be considered for coercion.
The color of the GDB equation
This value is not intrinsically stored with the equation, but is bundled for convenience.
The flags for the GDB equation
The flags track whether the equation is selected, used for graphing, or is participating in a link transfer.
tivars.var.SizedEntry.load_data_section
Loads the data of this entry from a bytestream
Parameters | |
data:BytesIO | The source bytes |
tivars.var.TIEntry.load_dict
Loads a JSON dict into this GDB equation
Parameters | |
dct:dict | The dict to load |
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 | The language used in string (defaults to English, en) |
mode | The tokenization mode to use (defaults to smart) |
The style of the GDB equation
This value is not intrinsically stored with the equation, but is bundled for convenience.