PrevCurrent Data File Format  Next

Name

script — A script packet

Synopsis

Content Model 
script ::= (var*, code,
            tag*,
            (container|textdata|script|attachment|
             tri|link|snappeadata|
             angles|surfaces|hypersurfaces|
             filtercomb|filterprop|filtertrivial|
             anon|anonref)*)
Attributes
NameType
idCDATA
labelCDATA

Added in Regina 7.0

Description

This represents a script packet, one of the many types of packet that together form the packet tree that a user sees when they open a Regina data file.

A script packet stores a Python script offering direct low-level access to the Regina calculation engine. The Python code is stored in the child code element.

A script may contain variables representing other packets in the same packet tree; these are described by the child var elements.

There are several child XML elements that are common to all packet types. The tag elements represent an arbitrary set of string “tags” that users can attach to a packet to help organise their data. The remaining child elements list all of Regina's packet types (container, textdata, etc.), and these represent the immediate children of this packet in the packet tree.

Parents

The following elements can contain any packet element (including this): angles, anon, anonref, attachment, container, filtercomb, filterprop, filtertrivial, hypersurfaces, link, regina, script, snappeadata, surfaces, textdata, tri. This list includes all packet types, as well as the top-level element regina.

Children

The following elements occur in script, and are specific to the script packet type: code, var.

The following children can occur in all packet elements: angles, anon, anonref, attachment, container, filtercomb, filterprop, filtertrivial, hypersurfaces, link, script, snappeadata, surfaces, tag, textdata, tri. This list includes all packet types, as well as the tag element for tagging individual packets.

Attributes

The following attributes are common to all packet types:

id

A unique identifier for this packet. Packets are not required to have IDs, but when they are present they must be distinct (i.e., no packets in the same file may share the same ID). IDs do not need to be human-readable, must not contain leading or trailing whitespace, and must not be empty strings. Currently, IDs are built from base 64 hashes of the underlying C++ pointers.

The purpose of these packet IDs is to allow other packets to reference this packet (for instance, so that a script packet can store references to its variables).

IDs are not required to stay the same across subsequent loads and saves of the same file. In other words, if you load a file and save it again, the packet IDs are allowed to change.

label

The name given by the user to this particular packet within the overall packet tree.

PrevContentsNext
reln Up simplex