tivars.types.settings.SettingsEntry

class documentation

class SettingsEntry(SizedEntry): (source)

Known subclasses: tivars.types.settings.TIRecallWindow, tivars.types.settings.TITableSettings, tivars.types.settings.TIWindowSettings

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

View In Hierarchy

Base class for settings entries

A settings entry stores all parameters for the different plot windows or tables

Method	`__format__`	Undocumented
Method	`load_dict`	Loads a JSON `dict` into this settings entry
Method	`load_string`	Loads this component from a string representation
Method	`summary`	No summary
Class Variable	`min_calc_data_length`	The minimum length of this entry's data

Inherited from SizedEntry:

Method	`calc_data`	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_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 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	`__init__`	Creates an empty entry with specified meta and data values
Method	`__iter__`	No summary
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	`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	`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	`extension`	The base file extension used for this entry
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	`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 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_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
Class Variable	`_type_id`	Undocumented

Inherited from Dock (via 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 __format__(self, format_spec: str) -> str: (source) ¶

overrides tivars.file.TIComponent.__format__

Undocumented

@Loader[dict]

def load_dict(self, dct: dict, **kwargs): (source) ¶

overrides tivars.var.TIEntry.load_dict

Loads a JSON dict into this settings entry

Parameters
dct:`dict`	The dict to load
**kwargs	Undocumented

@Loader[str]

def load_string(self, string: str): (source) ¶

overrides tivars.file.TIComponent.load_string

Loads this component from a string representation

If there is no dedicated handler for a component type, all subclasses of the type will be considered.

Parameters
string:`str`	The string to load

def summary(self) -> str: (source) ¶

overrides tivars.var.TIEntry.summary

Returns
`str`	A text summary of this component

min_calc_data_length: int = (source) ¶

overrides tivars.var.SizedEntry.min_calc_data_length

overridden in tivars.types.settings.TIRecallWindow, tivars.types.settings.TITableSettings, tivars.types.settings.TIWindowSettings

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