SpecTcl Programmer's Guide

SpecTcl Home  General Information User Guide Programmer's Guide Obtaining and Installing

This is the home page of the SpeCtcl programmer's guide. The intention of this page is to provide information about programming SpecTcl for:

• Those who will need to tailor SpecTcl to analyze a particular data set.
• People who will want to add access to scaler data to their SpecTcl for NSCL formatted data
• People who want to recover the values of run and state variables.
• People who want to be able to read filtered data sets.
• Those who are interested in knowing more about who SpecTcl is put together either with a view for extending its basic abilities or for maintaining the existing program.
• SpecTcl 3.0 includes an integrated implementation of TreeParam. Click here for documentation.
• Beginning with SpecTcl 3.0, some key classes are now documented as man pages. An HTML index to these man pages is available here.
• Beginning with SpecTcl 3.2, fitting is supported and can be extended. See the guide to extending the SpecTcl fit subsystem for more information
• Beginning with SpecTcl 3.2 Xamine client buttons can be created, programmed and caught. See SpecTcl's interface to Xamine Clients Buttons
• Beginning with Spectcl 3.2 SpecTcl allows your software to execute application specific code when Xamine has been restarted. See Writing Xamine Restart Handlers for more information about that.
• Compiled SpecTcl plugins are described in the SpecTcl Plugins Guide
• In block mode data taking systems one must often block several events into one unit. We refer to these units as super events. Beginning with SpecZTcl-3.2, SpecTcl includes support for analyzing super events. This support is described in SpecTcl and Super Events
• SpecTcl now includes an open source freely re-distributable splash screen package. Tailoring SpecTcl's Splash screens.

Throughout this guide, we will be using some diagrammatic notation to describe relationships between C++ classes. The notation we use is based on that of the Unified Modelling Language's class relationship diagrams. The interactions between objects is shown using UML sequence diagrams. Please become at least a little bit familiar with these diagram types before continuing.

Other conventions:

• Class names begin with C e.g. CEvent is a class representing events.
• Class member data names begin wih m_ e.g. m_Event
• Pointers begin with the letter p and references with the letter r. If a member, then these follow the m_ e.g. pEvent, rEvent are non members, m_pEvent, m_rEvent would be members.
• Function names are phrases with each word capitalized with no underscores e.g. DoSomethingUseful()

SpecTcl Home  General Information User Guide Programmer's Guide Obtaining and Installing

Last Modified: October 28, 2003 by: fox@nscl.msu.edu
© Copyright NSCL 1999, All rights reserved