File System Typescript Commands

These typescript commands deal with reading or writing files, saving or loading models, etc.

Include

Reads in a module or library from a file on disk.

include 0, class ident, #, #, #, #, filename

Example:

include 0, LinkLibrary Distribution_variati,2,2,0,0,C:\Program Files\Lumina\Analytica 4.2\Libraries\Distribution Variations.ANA

The various numbers are fields that were used on the Macintosh to identify disk volume IDs and other things specific to the Mac OS. On windows, the filename contains the relevant information. If the file path is relative, it is interpreted relative to the CurrentModelDirectory.

To do: More detail on what those Mac-numbers are.

Update

Puts Analytica into an update (merge) mode, so that it allows redeclarations of already created objects. Existing attributes of such objects will be overwritten by new attributes. This mode is used when merging a new version of a module or library into an existing model.

EndUpdate

Ends the Update mode begun with the Update command.

Save

This command saves values or module contents to disk. I have not used or tried this command, and it has not been part of the Analytica QA process, so it may or may not work. The implementation is very old and hasn't been visited in more than 12 years, so I wouldn't get too excited about it working. Further research is required to flesh out its full description.

The syntax is something like:

Save fmt [Model|Module|Library|LinkModule|LinkLibrary] [Each|All|Every] «ident»

Fmt is a number that identifies the file format. I think the recognized format (which might not actually be implemented) are:

0 = Analytica standard model format

1 = Tab-delimited format

2 = Sylk format

3 = Biff format

The Model|Module|etc keyword is optional, and apparently it behaves differently depending on whether that is specified. The Each|All|Every controls whether it saves only the top level or saves all descendant objects.

SoftwareVersion

When a model file is being loaded, this command specifies the release number of the Analytica software that the file was saved from. If the version specified is later than the current release number, the command triggers the display of a warning stating that the model is from a more recent version of Analytica.

If the specified release number is earlier than the current release, configures the Analytica reader and parser to accept the format and syntax that was in use at the time the model was saved, and may also trigger certain conversions to be made as the file is loaded to ensure backward compatibility (so that models from older releases continue to run in newer releases). The configuration remains active until the file being read is closed.

This command is usually the first command appearing inside a model or module file saved by Analytica.

Obfuscated

The presence of this command in an input channel marks the input channel being in an obfuscated format. The characters read from that point on are assumed to be encrypted.

You do not want to type this into the typescript window (otherwise, you'd have to type everything in encrypted form, which presumably you would not know how to do).

Model or module files saved from Analytica Enterprise using "Save A Copy..." with the obfuscate checkbox will write this command, then write the remainder of the file in an obfuscated (encrypted) format.

---

The following commands have something to do with File output, but they may belong in the deprecated category.

ResumeRecord

There seems to have been some sort of facility in Demos to open a "record channel", which I think is an output file. These commands open a file as the current output channel, suspend and resume this as the current output channel, and close the channel.

I've never used it or seen it used, and don't know if it still works, or what it is useful for. This is a feature from very early days of Demos.

EndPhoto

The photo file/buffer is, I think, similar to the record, but I think it has something to do with capturing the contents of the typescript window.

There is a "Photo" feature in ADE, which is documented, and indeed does exactly this -- keeps a log of all typescript interaction since ADE started.

How eactly these commands work (or if they work) is not known to me.