ID

Object identification string

Description:

This attribute contains a string which may be used to identify the Object to which it is attached. There is no restriction on the contents of this string, which is not used internally by the AST library, and is simply returned without change when required. The default value is an empty string.

An identification string can be valuable when, for example, several Objects have been stored in a file (using AST_WRITE) and are later retrieved (using AST_READ). Consistent use of the ID attribute allows the retrieved Objects to be identified without depending simply on the order in which they were stored.

This attribute may also be useful during debugging, to distinguish similar Objects when using AST_SHOW to display them.

Type:
String.

Applicability

Object
All Objects have this attribute.

Notes: