packet


	packet

Name

packet — A single packet in a data file

Synopsis

Content Model
packet ::= (`type-specific content`, `tag`, `packet`) The contents of a `packet` element depend upon the particular type of packet (such as container, text, triangulation and so on). The specific content model for each packet type is documented on its own reference page; see below for details.
Attributes
Name	Type
`label`	CDATA (required)
`parent`	CDATA
`type`	CDATA
`typeid`	NUMBER (required)

Description

A packet element represents a single packet in a Regina data file. A packet is a single data object, such as a triangulation, a text note or a Python script. A general discussion of packets and their different types can be found in the users' handbook.

The precise packet content model differs between packet types. These type-specific content models are individually documented on the following reference pages.

Each packet may have an arbitrary set of string tags associated with it; these are represented by the child tag elements.

Packets in a data file are arranged in a tree structure; each packet (aside from the top-level packet) has a single parent packet and zero or more child packets. The child packets of this packet are represented by the child packet elements of this element.

Parents

The following elements contain packet: packet, reginadata.

Children

The following elements occur in packet regardless of packet type: packet, tag.

Additional elements may also occur for specific packet types; these are documented on separate reference pages for each individual packet type (see above).

Attributes

label: The label of this particular packet, i.e., the name associated with this packet in the overall packet tree. No two packets in a packet tree should have the same label.
parent: The label of the parent of this packet in the overall packet tree. This attribute should be the empty string if this packet has no parent (i.e., this packet is the root of the entire packet tree).
type: The packet type expressed as a human-readable string. Example types are Container, Text and Triangulation.
typeid: The packet type expressed as an internal identification code. This will be a positive integer.

Prev	Contents	Next
orbl (surface)	Up	packet (angle structure list)