class documentation
class TINewEquation(TIEquation): (source)
Constructor: TINewEquation(init, name, version, archived, data)
Parser for internal equations
A TINewEquation is simply a TIEquation with certain internal uses.
| Class Variable | _type |
Undocumented |
Inherited from TIEquation:
| Method | __init__ |
Creates an empty entry with specified meta and data values |
| Method | name |
The name of the entry |
| Class Variable | extension |
The base file extension used for this entry |
| Class Variable | leading |
Byte that always begins the name of this entry |
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__ |
Undocumented |
| Method | __iter__ |
No summary |
| 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 | lines |
Splits this entry into logical lines: lines separated by newlines or colons lying outside string literals |
| Method | load |
Loads a byte string or bytestream into this entry |
| Method | load |
Loads this entry from a string representation |
| Method | load |
Loads this entry from a sequence of TIToken objects |
| Method | string |
Decodes this entry into a string of tokens |
| Method | tokens |
No summary |
| Class Variable | clock |
Tokens which interface with the RTC |
| Class Variable | min |
The minimum length of this entry's data |
| Class Variable | versions |
The possible versions of this entry |
Inherited from SizedEntry (via TIEquation, TokenizedEntry):
| Method | calc |
The data section of the component which is loaded on-calc |
| Method | clear |
Clears this entry's data |
| Method | data |
The component's user data |
| Method | get |
Determines the length of this entry's user data section |
| Method | length |
The length of this entry's user data section |
| Method | load |
Loads the data of this entry from a bytestream |
Inherited from TIEntry (via TIEquation, TokenizedEntry, SizedEntry):
| Class | |
No class docstring; 3/3 properties, 0/1 class variable, 1/1 method documented |
| Class Method | get |
Determines the file extension for a targeted model based on its contents |
| Class Method | get |
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 |
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 | dict |
No summary |
| Method | export |
Exports this entry to a TIVarFile with a specified name and header |
| Method | load |
Loads this component from a JSON dictionary representation |
| 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 | summary |
No summary |
| Method | supported |
Determines whether a given model supports this entry |
| Method | type |
The type ID of the entry |
| Method | unarchive |
Unarchives this entry |
| 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 | for |
Whether this entry supports flash chips |
| Property | meta |
The meta section of this entry |
| Method | __init |
Undocumented |
| Class Variable | _type |
Undocumented |
Inherited from TIComponent (via TIEquation, TokenizedEntry, 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 | coerce |
Coerces this component to a subclass if possible using the component's type ID |
| Method | json |
No summary |
| Method | load |
Loads this component from a JSON dictionary representation |
| Method | update |
Updates this component's metadata |
| Property | is |
Whether this component's data is empty |
Inherited from Dock (via TIEquation, TokenizedEntry, 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 |