Reference Guide for Swarm 2.2
Prev |  | Next

# Reference Guide for Swarm 2.2

### Swarm Development Group

2003-09-08

Copyright © 1996-2003 Swarm Development Group

Licence terms for Swarm documentation

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

The XML source and associated utilites needed to generate this documentation can be found in the package: swarmdocs-2003-09-08.tar.gz. Whilst the documentation itself is under the GFDL, all code for used to generate the documentation is distributed under the GNU GPL.

Licence terms for Swarm software

The copyright holders make no representation about the suitability of Swarm for any purpose. It is provided “as is” without expressed or implied warranty. Please refer to the GNU General Public Licence (GPL). Permission to use, copy, modify and distribute Swarm must be in accordance with the GPL.

30 December 2004

Revision History
Revision Makefile.am | 2003-09-10 | alex
(gridturtle_srcdir): Remove.
Revision refbook.xml | 2003-09-08 | alex
Use 4.2 version of DocBook XML DTD.
Revision Makefile.am | 2001-11-26 | alex
include Makefile.common, not refbook/Makefile.rules, the EXTRA_DIST and noinst_nodist_DATA macros were conflicting, automake 1.5 flags this as an error (SUBDIRS): Remove 'tech' subdirectory. Moved to User Guide. (swarm_ChangeLog): Remove, automake now smart enough to get this target from included Makefile.
Revision refbook.xml | 2001-11-26 | alex
Move gfdl.xml ENTITY into DOCTYPE header, because no longer defined in global.ent.
Revision refcont.xml | 2001-11-25 | alex
Add GFDL as <appendix>.
Revision refmeta.xml | 2001-11-25 | alex
Use <mediaobject> in place of <graphic>, which will be obsoleted in V5.0 of DTD.
Revision refbook.xml | 2001-11-25 | alex
Update DOCTYPE to DocBook XML DTD V4.1.2.
Revision sgml.el | 2001-11-25 | alex
Emit tags that are all strict XML (lowercase element names and attributes throughout, with empty elements such as <void>, renamed using the <void/> syntax). Change all file suffixes to '.xml'
Revision Makefile.am | 2001-11-25 | alex
Change {SGML,sgml} to {XML,xml} throughout.
Revision Makefile.rules | 2001-11-25 | alex
Likewise.
Revision refbook.ent | 2001-11-25 | alex
Make entities conform with strict XML.
Revision *.sgml | 2001-11-25 | alex
Converted to strict XML and renamed with .xml extension.
Revision sgml.el | 2000-07-17 | mgd
(module-package-string): New function. (sgml-object-id, sgml-examples, sgml-method-examples): Use it. (module-path-string): New function. (sgml-pathname-for-swarmdocs-pages-output, sgml-examples,sgml-method-examples): Use it. (sgml-method-signature-id): Handle getters phase.
Revision refcont.sgml | 2000-07-17 | mgd
Add swarmcont.
Revision refbook.ent | 2000-07-17 | mgd
Add entities for Swarm swarmcont.sgml and generated swarmpages.sgml.
Revision sgml.el | 2000-07-09 | mgd
(sgml-pathname-for-swarmdocs-pages-output): Moved from Swarm's etc/common.el.
Revision license-app.sgml | 2000-07-04 | alex
Give IMPORTANT box a TITLE.
Revision grid-app.sgml | 2000-07-04 | alex
Likewise.
Revision refbook.sgml | 2000-07-04 | alex
Declare lt and gt entities in the prolog for down-conversion to XML compatibility.
Revision refmeta.sgml | 2000-06-13 | alex
Add link directly to Random Appendix in User Guide.
Revision refbook.sgml | 2000-05-30 | alex
Update DOCTYPE to DocBook DTD V4.0.
Revision refmeta.sgml | 2000-05-30 | alex
GRAPHIC tag has no content, remove obsoleted BOOKBIBLIO tag.
Revision ref00a.sgml | 2000-05-30 | alex
Make illegal TITLE element a BRIDGEHEAD.
Revision conventions-app.sgml, license-app.sgml, grid-app.sgml | 2000-05-30 | alex
DOCINFO tag -> APPENDIXINFO.
Revision ref00a.sgml | 2000-04-23 | mgd
Note rename of EZBin's -getStd to -getStdDev.
Revision | 2000-03-28 | mgd
Swarmdocs 2.1.1 frozen.
Revision | 2000-03-01 | mgd
Swarmdocs 2.1 frozen.
Revision Makefile.am, Makefile.rules | 2000-03-01 | mgd
(nodist_noinst_DATA): Add. Needed in order to get the dependency for generated SGML. (gridexamples.sgml): Remove. (GENERATED_SGML): Remove gridexamples.sgml. (EXAMPLES): Remove. (refindex.sgml $(PAGES), graph): Quote SWARMSRCDIR and SWARMDOCS.
Revision grid-app.sgml | 2000-03-01 | mgd
Add LINK to IMPORTANT for all files.
Revision ref00a.sgml | 2000-03-01 | mgd
Remove obsolete reference to release changes.
Revision refcont.sgml | 2000-03-01 | alex
Remove {lgpl,gpl}-app.sgml inclusion in content.
Revision refbook.ent | 2000-03-01 | alex
Likewise for the relevant ENTITIES.
Revision lgpl-app.sgml, gpl-app.sgml | 2000-03-01 | alex
Remove files.
Revision Makefile.am | 2000-03-01 | alex
(SGML): Add license-app.sgml.
Revision refmeta.sgml | 2000-03-01 | alex
Add admonition regarding reorganization and deletion of appendices in ABSTRACT.
Revision grid-app.sgml | 2000-03-01 | alex
Remove the inline gridturtle code. Add admonition specifying location of tar.gz file for download.
Revision Makefile.am | 2000-03-01 | alex
(noinst_DATA): Remove variable entirely, since we neither install nor distribute the GENERATED_SGML files.
Revision Makefile.rules | 2000-03-01 | alex
(noinst_DATA): Likewise for generated revhistory.sgml files
Revision ref00a.sgml | 2000-02-29 | mgd
Add 2.1 porting notes.
Revision ref00.sgml | 2000-02-15 | alex
Update Acknowledgment section and remove swarm@santafe.edu mailto link.
Revision refcont.sgml | 2000-02-15 | alex
Comment-out random-app.sgml, probes-app.sgml, techcont.sgml APPENDIXes. All material either outdated or relocated to the Swarm User Guide.
Revision graph.el | 1999-09-22 | mgd
Use TOP_BUILDDIR, rather than BUILDDIR to load protocol.
Revision sgml.el | 1999-06-22 | mgd
(sgml-method-definitions): Use methodinfo- functions instead of list accessors.
Revision Makefile.am | 1999-06-22 | alex
(sgml.elc): Depend on $(abs_top_builddir)/protocol.elc, rather than just protocol.elc. (refindex.sgml $(PAGES)): Likewise. (graph): Likewise.
Revision sgml.el | 1999-06-22 | alex
(load-path): Set to TOP_BUILDDIR, rather than BUILDDIR.
Revision sgml.el | 1999-06-21 | alex
(sgml-refmeta): If deprecated protocol, print Deprecated in square braces after REFENTRYTITLE. (sgml-refsect1-text-list): Print out the deprecated doc-string if set, as a PARA element with EMPHASIS before description text. (sgml-refsect1-description): Pass object to `sgml-refsect1-text-list', so it can determine whether to print deprecated doc-string.
Revision Makefile.am | 1999-06-21 | mgd
(protocol.elc): Remove rule.
Revision ref00a.sgml | 1999-06-02 | alex
Add porting notes for 1.4/1.4.1 -> 2.0 changes.
Revision Makefile.am | 1999-04-23 | mgd
(EXTRA_DIST): Add graph.el. (MODULES): New variable: (SUBDIRS): Use it. (graph): New target.
Revision graph.el | 1999-04-23 | mgd
Moved here from toplevel directory.
Revision refbook.sgml | 1999-04-06 | alex
Update PUBLIC identifier for DTD to "-//OASIS//DTD DocBook V3.1//EN" Remove JPEG notation class - now part of the 3.1 DTD.
Revision sgml.el | 1999-02-28 | alex
(run-all): Set uniquify-method-lists to `nil' when calling load-and-process-modules. Ensures all method documentation called correctly.
Revision Makefile.am | 1999-02-24 | mgd
(protocol.elc): Dependency on $(swarm_srcdir)/etc/protocol.el. (sgml.elc): Dependency on common.elc and protocol.elc. Both rely on implicit rules. (EXTRA_DIST): Add sgml.el.
Revision sgml.el | 1999-02-24 | mgd
(sgml-generate-indices): Use get-top-builddir instead of get-swarmdocs-build-area.
Revision Makefile.am | 1999-02-16 | mgd
(refindex.sgml $(PAGES)): Depend on $(swarm_srcdir)/etc/{protocol,common}.el instead of $(top_srcdir)/{protocol,common}.el. Load sgml.el instead of protocol.el.
Revision refcont.sgml | 1999-02-09 | alex
(random-app.sgml): Add `Random' Appendix to list of contents.
Revision refmeta.sgml | 1999-01-26 | alex
Move bibliodata entity outside of BOOKBIBLIO - so legalnotice links work.
Revision ref00a.sgml | 1999-01-23 | mgd
Remove porting note about .swarmArchiver. Swarm 1.4 will read old files, but then change the syntax.
Revision ref00a.sgml | 1999-01-15 | alex
Add porting note on Histogram protocol change.
Revision refmeta.sgml | 1999-01-13 | alex
Remove old LEGALNOTICE text. Refer the newly-defined {doc,swarm}-legalnotice entities from global.ent. Move CORPAUTHOR inside BOOKBIBLIO.
Revision gpl-app.sgml | 1999-01-13 | alex
Refer to the Swarm documentation as being under the terms of the GPL.
Revision ref00a.sgml | 1999-01-13 | alex
(SECT1): Add porting notes for Swarm 1.4.
Revision ref00a.sgml | 1999-01-07 | alex
Make SIMPLELIST an ITEMIZEDLIST.
Revision gpl-app.sgml | 1999-01-07 | alex
Remove SIDEBAR from wrapping the licence text, SIDEBAR can't run over a page in the printed backend. Make introductory description a SIDEBAR.
Revision lgpl-app.sgml | 1999-01-07 | alex
Likewise.
Revision ref00.sgml | 1999-01-07 | alex
Replace SECT1 with two SIMPLESECTs. Tidying and reformatting. (Acknowledgements): Updated.
Revision probes-app.sgml | 1998-12-22 | alex
({customized,complete}-probe-map): Add IDs to FIGUREs
Revision refbook.tex.in | 1998-10-14 | mgd
Use top_dossrcdir instead of top_srcdir.
Revision refbook.tex.in | 1998-10-09 | mgd
Include tex/macros.tex.
Revision ref00a.sgml | 1998-08-25 | mgd
Add 1.2 -> 1.3 porting notes.
Revision ref00a.sgml | 1998-07-23 | mgd
Put items related to HeatbugObserverSwarm.h in their own list.
Revision ref00a.sgml | 1998-07-18 | mgd
Clarify wording about not using statically typed Swarm objects.
Revision Makefile.am | 1998-06-25 | alex
(refindex.sgml $(PAGES)): Set temporary environment variable SWARMSRCDIR before invocation of batch-mode e-lisp program `protocol.el'.
Revision ref00a.sgml | 1998-06-24 | alex
Tidied 1.1 => 1.2 porting notes.
Revision ref00a.sgml | 1998-06-23 | alex
Added porting notes for Swarm 1.1 => 1.2. Expanded porting notes for Swarm 1.0.5 => 1.1. Added intro SIDEBAR.
Revision refmeta.sgml | 1998-06-17 | mgd
Use refbookrevhistory.sgml instead of srcrevhistory.sgml. Scale graphic to 100%.
Revision refbook.sgml | 1998-06-17 | mgd
Use refbook.ent instead of src.ent.
Revision Makefile.am | 1998-06-17 | mgd
Include refbook/Makefile.rules instead of src/Makefile.rules. (GENERATED_SGML): Rename srcrevhistory.sgml to refbookrevhistory.sgml. (ENT, EXTRA_DIST): Use refbook.ent instead of src.ent.
Revision refbook.ent | 1998-06-17 | mgd
Renamed from src.ent.
Revision probes-app.sgml | 1998-06-16 | alex
(complete-probe-map): Scale graphic to 50%. (customized-probe-map): Scale graphic to 75 %. In 'Support for Probing' section - make ITEMIZEDLIST spacing=compact.
Revision Makefile.am | 1998-06-15 | mgd
Include $(top_srcdir)/src/Makefile.rules. (SGML): Move ENT to SGML_FILES. (EXTRA_DIST): New variable.
Revision Makefile.rules | 1998-06-15 | mgd
New file.
Revision refmeta.sgml | 1998-06-12 | mgd
Scale graphic to 75%.
Revision Makefile.am | 1998-06-12 | mgd
(gridexamples.sgml): Update IDs to SWARM.module.SGML.type.
Revision conventions-app.sgml, gpl-app.sgml, grid-app.sgml, lgpl-app.sgml, probes-app.sgml, ref00.sgml, ref00a.sgml, refmeta.sgml | 1998-06-12 | mgd
Likewise.
Revision refbook.sgml | 1998-06-11 | mgd
Use jpeg instead of jpg for notation and local.notation.class.
Revision Makefile.am | 1998-06-10 | mgd
Move CLEANFILES to Makefile.rules. (GENERATED_SGML): Move versions.ent to Makefile.rules. (ENT): New variable, the list of .ent files for this module. (SGML): Add ENT.
Revision lgpl-app.sgml, gpl-app.sgml, ref00a.sgml | 1998-06-10 | alex
Fixed the IDs to have the appropriate "SWARM.SRC." prefix in the content ID.
Revision ref00.sgml | 1998-06-10 | alex
Made SIMPLESECTs into SECT2s. Fixed redundant "SWARM.SRC." in PREFACE id.
Revision refmeta.sgml | 1998-06-09 | alex
Change CORPAUTHOR to 'corpauthor' - an SFI Hive global entity.
Revision refmeta.sgml | 1998-06-09 | mgd
Change CORPAUTHOR to SDP. Overview needlessly wordy.
Revision refbook.sgml.in | 1998-06-08 | mgd
Use public identifer for global.ent, and src.ent. Add versions.ent and figs.ent.
Revision Makefile.am | 1998-06-08 | mgd
(GENERATED_SGML): Add versions.ent.
Revision src.ent.in | 1998-06-07 | mgd
Define graphic entities per html/print.
Revision refbook.sgml.in | 1998-06-07 | mgd
Add local.notation.class entity and notation for JPG.
Revision config.ent | 1998-06-07 | alex
Removed.
Revision src.ent | 1998-06-07 | alex
Removed reference to config.ent.
Revision src.ent.in | 1998-06-06 | mgd
Don't use extracted locations, as module entities now all reference public identifiers.
Revision src.ent.in | 1998-06-05 | mgd
Add srcrevhistory.sgml.
Revision refmeta.sgml | 1998-06-05 | mgd
Replace REVHISTORY with srcrevhistory.sgml.
Revision Makefile.am | 1998-06-05 | mgd
(SUBDIRS): Add tech. (swarm_ChangeLog): Add (empty). (GENERATED_SGML): Add srcrevhistory.sgml.
Revision Makefile.am | 1998-06-03 | alex
(CLEANFILES): Changed hardcoded refbook.rtf to $(NAME).rtf. Added Local variable mode for emacs makefile-mode.
Revision Makefile.am | 1998-06-03 | mgd
(gridexamples.sgml): Remove unnecessary subshell for `for' loop and don't cd to $(srcdir) when done (it's in a subshell).
Revision grid | 1998-06-01 | alex
Moved the grid subdir to the root of the Swarm application source tree and renamed to gridturtle.
Revision Makefile.am | 1998-06-01 | alex
(gridexamples.sgml): After changing directories into $(gridturtle_srcdir) - change directory back to $(srcdir) to restore location.
Revision Makefile.am | 1998-06-01 | mgd
(swarm_srcdir, gridturtle_srcdir): New variables which get substituted assignments from configure. Use them instead of $(SWARMHOME) and $(srcdir)/grid.
Revision grid-app.sgml | 1998-06-01 | alex
Fixed incorrect LINKENDS and descriptions for grid5.m and grid6.m.
Revision probes-app.sgml | 1998-05-29 | mgd
Update LINKENDs per new ID conventions.
Revision Makefile.am | 1998-05-26 | mgd
(refindex.sgml $(PAGES)): Add protocol.el and common.el and set SWARMDOCS to top_srcdir.
Revision refbook.sgml.in | 1998-05-23 | mgd
New file.
Revision refbook.tex.in | 1998-05-23 | mgd
New file.
Revision refbook.sgml | 1998-05-23 | mgd
Removed.
Revision Makefile.am | 1998-05-23 | mgd
New file.
Revision Makefile | 1998-05-23 | mgd
Remove.
Revision src.ent.in | 1998-05-23 | mgd
New file.
Revision src.ent | 1998-05-23 | mgd
Removed.
Revision | 1998-05-22 | mgd
Begin revision log.

Overview

Swarm is a collection of libraries against which you link your simulation code. This document describes the interface for those core libraries.

### Important

The probe, random and technical appendices formerly part of the Reference Guide for Swarm have been removed and relocated to the new Random Library Appendix in the Swarm User Guide. In the interests of conserving paper, the grid turtle example programs are available in `tar.gz` format from the Swarm ftp site (see Appendix A, GridTurtle Test Programs) and pointers to the full text of the LGPL and GPL licenses (see Appendix C, Licenses for Distribution of Swarm and Applications) are provided rather than the full text itself.

List of Examples

defobj/Arguments/1.
defobj/Create/1.
defobj/Customize/-customizeCopy:/1.
defobj/Customize/1.
defobj/Serialization/-lispStoreIntegerArray:Keyword:Rank:Dims:Stream:/1.
defobj/Serialization/-lispSaveStream:Boolean:Value:/1.
collections/Index/-getLoc/1.
activity/ActionCreatingTo/1.
objectbase/Swarm/-activateIn:/1.
analysis/EZSequence/-setUnsignedArg:/1.
space/Discrete2d/1.

Prev |  | Next
Overview of the Swarm Distribution | Home | Preface