skeleton.cpp

Go to the documentation of this file.

/* Change the line below if we ever move out of CES branch drivers:

 */
#ifndef CESCAMAC
#define CESCAMAC
#endif

/*
                    GNU GENERAL PUBLIC LICENSE
                       Version 2, June 1991

 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
                       59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

                            Preamble

  The licenses for most software are designed to take away your
freedom to share and change it.  By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users.  This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it.  (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.)  You can apply it to
your programs, too.

  When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.

  To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.

  For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have.  You must make sure that they, too, receive or can get the
source code.  And you must show them these terms so they know their
rights.

  We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.

  Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software.  If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.

  Finally, any free program is threatened constantly by software
patents.  We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary.  To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.

  The precise terms and conditions for copying, distribution and
modification follow.

                    GNU GENERAL PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License.  The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language.  (Hereinafter, translation is included without limitation in
the term "modification".)  Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope.  The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.

  1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.

You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.

  2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:

    a) You must cause the modified files to carry prominent notices
    stating that you changed the files and the date of any change.

    b) You must cause any work that you distribute or publish, that in
    whole or in part contains or is derived from the Program or any
    part thereof, to be licensed as a whole at no charge to all third
    parties under the terms of this License.

    c) If the modified program normally reads commands interactively
    when run, you must cause it, when started running for such
    interactive use in the most ordinary way, to print or display an
    announcement including an appropriate copyright notice and a
    notice that there is no warranty (or else, saying that you provide
    a warranty) and that users may redistribute the program under
    these conditions, and telling the user how to view a copy of this
    License.  (Exception: if the Program itself is interactive but
    does not normally print such an announcement, your work based on
    the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole.  If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works.  But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.

In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.

  3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:

    a) Accompany it with the complete corresponding machine-readable
    source code, which must be distributed under the terms of Sections
    1 and 2 above on a medium customarily used for software interchange; or,

    b) Accompany it with a written offer, valid for at least three
    years, to give any third party, for a charge no more than your
    cost of physically performing source distribution, a complete
    machine-readable copy of the corresponding source code, to be
    distributed under the terms of Sections 1 and 2 above on a medium
    customarily used for software interchange; or,

    c) Accompany it with the information you received as to the offer
    to distribute corresponding source code.  (This alternative is
    allowed only for noncommercial distribution and only if you
    received the program in object code or executable form with such
    an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for
making modifications to it.  For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable.  However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.

If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.

  4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License.  Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.

  5. You are not required to accept this License, since you have not
signed it.  However, nothing else grants you permission to modify or
distribute the Program or its derivative works.  These actions are
prohibited by law if you do not accept this License.  Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.

  6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions.  You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.

  7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all.  For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.

It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices.  Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.

This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.

  8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded.  In such case, this License incorporates
the limitation as if written in the body of this License.

  9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time.  Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number.  If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions 
either of that version or of any later version published by the Free Software 
Foundation.  If the Program does not specify a version number of this License,
 you may choose any version ever published by the Free Software Foundation.

  10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author to 
ask for permission.  For software which is copyrighted by the Free Software 
Foundation, write to the Free Software Foundation; we sometimes make 
exceptions for this.  Our decision will be guided by the two goals of 
preserving the free status of all derivatives of our free software and of 
promoting the sharing and reuse of software generally.

                            NO WARRANTY

  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN 
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE 
THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, 
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND 
PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, 
YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO 
LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR 
THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 
DAMAGES.

                     END OF TERMS AND CONDITIONS
*/
static const char* Copyright= "(C) Copyright Michigan State University 2002, All rights reserved";/*
** Ported to Linux and CES/CBD 8210 device driver.
** At present, the preprocessor symbol __unix__ is used to switch on/off
** Linux/unix specific  code. #ifndef for it is used to switch off VME 
** 68K specific code.
**   >>>>This module must be compiled without optimization<<<<
**      Ron Fox
**      January 28, 1999
*/


/*
**++
**  FACILITY:
**
**      Data acquisition system.
**
**  ABSTRACT:
**
**      skeleton.c  - This file contains an upper level readout skeleton.
**                      This skeleton is called from the evtuser.c skeleton
**                      at even more confined locations than evtuser.c  The
**                      user here is providing routines that tyipcally just do
**                      CAMAC operations and not much else.
**                      Users performing tailoring should read carefully
**                      the areas which begin with the text:
**
**                      INSTRUCTIONS:
**                      -------------
**
**  AUTHORS:
**
**      Ron Fox
**
**
**  CREATION DATE:      6-Mar-1990
**
**  MODIFICATION HISTORY:
**
**--
*/


/*
**
**  
INCLUDE FILES
**
*/


#include <stdio.h>
#include <string>
#include <tcl.h>

#include <TCLInterpreter.h>
#include <TCLVariable.h>
#include <TCLException.h>
#include <CNullBusy.h>
#include <ReadoutStateMachine.h>
#include <Active.h>

#include "CDigitizerDictionary.h"
#include "CReadOrder.h"
#include "CModuleCommand.h"
#include "CCAENV785Creator.h"
#include "CCAENV792Creator.h"
#include "CCAENV775Creator.h"
#include "CPacketCreator.h"
#include "CAENcard.h"

#include "CCAENV830.h"
#include "CCAENV830Creator.h"
#include "CCAENV830Module.h"

#ifndef __unix__
#include "cpus.h"
#endif

#ifdef __unix__
#include <stdlib.h>
#include <daqinterface.h>
#include <spectrodaq.h>
#endif

#include <daqdatatypes.h>
#include <camac.h>
#include <macros.h>

#ifdef VME16
#undef VME16
#endif
#if CPU == MICROPROJECT
#define VME16 0 
#endif

#ifndef __unix__
#include <vme.h>
#endif
#include <buftypes.h>

/* Short circuit run time evaluation of constant BCNAF's */

#ifdef __unix__
#include <camac.h>
#else
#if CPU == IRONICS
#undef CAMBAS
#define CAMBAS(b)       0xFA800000
#endif

#if CPU == MICROPROJECT
#undef CAMBAS
#define CAMBAS(b)       0xFE800000
#endif
#endif

#include <iostream.h>
#include <CAENcard.h>

#define SEE_PACKETID   0x8000     // SEE Packet id from Bazin.


/*
**  INSTRUCTIONS:
**  -------------
**                          Introduction
**
**      There are several functions that the user is supposed to fill in
**      to tailor this skeleton for a particular experiment.  While the
**      skeleton is written in C, several extensions to the C language have
**      been defined to bring the syntax closer to FORTRAN.  One thing you must
**      be aware of, however is that C is case sensitive, that is, 'if' and
**      'IF' are completely different from each other and 'If'.
**
**                          Functions to fill in:
**
**      The following are the set of functions that need to be filled in:
**
**      Function    Meaning             When Called
**      initevt     Init event readout  Power up Begin run and Resume Run.
**      clrtrig1    Clr trig1 readout   Power up, Begin, resume, end of trig1.
**      iniscl      Init scalers.       Power up Begin run and Resume Run.
**      clearevt    Clear evt readout   Power up, Begin, Resume, end of event.
**      clrtrig1    Clr trig1 readout   Power up, Begin, resume, end of trig1.
**      clrscl      Clear scaler readout Power up, Begin, Resume, end of scaler
**      readevt     Read an event       Event trigger.
**      readscl     REad scaler event   Scaler time.
**      trig1ena    Enable trigger 1    Begin run, resume run.
**      trig1dis    Disable trigger1    End run
**      rdtrig1     Readout for trig 1  User trigger 1 fires.
**      evtmax      Max size of event   Begin run time.
**      trig1max    Max words in trig1  Begin run time.
**
**                      Language elements:
**          Statements:
**      Statements can occur anywhere on a line there can even be multiple
**      statements on a single line. The end of a statement is flagged with
**      a semicolon.  The following are legal statements:
**
**              a = b;
**              camwrite16(0,1,29,0,16,1234);
**
**          Variables:
**      Variables must be declared at the beginning of a function.
**      C variables are the native type, however, the following FORTRAN
**      style variable declarations are supported via definitions in 
**      macros.h
**
**          LOGICAL     - Takes the values TRUE or FALSE
**          WORD        - INTEGER*2 sized word.
**          INTEGER     - INTEGER*4 sized lognword.
**          REAL        - REAL*4 sized real.
**
**      Arrays may be declared, subscripts always go from 0:size-1. In C
**      subscripts are in square brackets not rounded ones. The following
**      are legal variable declarations:
**
**          LOGICAL flag;
**          INTEGER i,j,k[10];
**      Note in the above, the declaration of k is identical to the FORTRAN
**      declaration:
**
**          INTEGER*4 k(0:9)
**
**      Multidimensional arrays are also allowed, but the syntax is a bit
**      different:
**          IINTEGER twod[5][6];
**
**      In C, the last dimension runs sequentially in memory rather than
**      the first (reverse of fortran), and array references require both
**      dimensions to be used as in the declaration e.g., to fill the
**      array above:
**         
**               for(j = 0; j < 5; j++) 
**                  for(i = 0; i < 6; i++)
**                     twod[j][i] = i+j;
**         
**          Expressions:
**      The only FORTRAN operators not allowed are exponentiation (**).
**      the following is a subset of the operators supported:
**          + - * / AND OR EQ NE GT GE LT LE
**      The following assignment statement is an example of an expression:
**          LOGICAL   flag;
**          INTEGER   i1,i2,i3,i4;
**              ...
**          flag = (i1)/(i1+i2) LT (i3+i4)
**
**      Note that operators (e.g. LT above) are case sensitive.
**      Bitwise operator functions IAND, IOR, ISHIFT are defined like in FORTRAN
**      Hexadecimal constants are allowed and the syntax is 0xNNN where NNN is
**      the constant.
**
**          Flow of control:
**
**      The following statements can control the flow of a program.
**              IF
**
**      IF(expresson) <statement>;
**
**              BLOCK IF with optional ELSE clause:
**
**      IF(expression) THEN
**          <statements with trailing ';'s>
**      [ELSE 
**          <statements with trailing ';'s>
**      ]ENDIF
**
**              Top tested DO WHILE loop:
**
**      DO WHILE(expression)
**          <statements>;
**      ENDDO
**
**                  Buffer manipulation:
**      The following functions manipulate the buffer:
**
**      putbufw(w)      - Put w, a 16 bit word to buffer.
**      putbufl(l)      - Put l, a 32 bit longword to the buffer in VAX word 
**                        order.
**
**                  CAMAC operations:
**
**      In the discussion below, b= branch number 0-7, c = crate number 1-7,
**      n = CAMAC slot, a = CAMAC subaddress, f = CAMAC function code.
**      d = CAMAC data transfered.
**      CAMAC operations are implemented as 'pseudo functions' which are
**      expanded in line and hence quite fast (~3usec per transaction).
**
**      camread16(b,c,n,a,f)    - Returns a 16 bit value read from CAMAC
**      camread24(b,c,n,a,f)    - Returns a 24 bit value read from CAMAC format
**                                is 68K format.
**      camwrite16(b,c,n,a,f,d) - Write least significant 16 bits of d to CAMAC
**      camwrite24(b,c,n,a,f,d) - Write least significate 24 bits of d to CAMAC
**      camctl(b,c,n,a,f)       - Perform non data transfer CAMAC cycle.
**      rdtobuf16(b,c,n,a,f)    - Do 16 bit CAMAC read into buffer.
**      rdtobuf24(b,c,n,a,f)    - Do 24 bit CAMAC read into buffer (VAX format).
**      qtst(b)                 - TRUE if most recent CAMAC operation on 
**                                given branch set Q
**      xtst(b)                 - Same as qtst, but tests X status.
**
**              More complex pseudo functions:
**
**      qstop(b,c,n,a,f)        - Performs a Q stop block read into buffer.
**      branchinit(b)           - Initialize branch controller.
**      crateinit(b,c)          - C/Z/Uninhibit crate.
**
**              LAM waiting:
**
**      The Pseudo functions below set up to do LAM busy waiting on a bit
**      register decode:
**
**      BEGINLAM(numbr, numcr)  - Begin LAM mask buildup:
**                                      numbr   - Number of branches involved
**                                                in LAM wait process.
**                                      numcr   - Highest crate number involved
**                                                in LAM wait process.
**      ENDLAM                  - End LAM mask processing.
**      READBIT(b,c,n,a,f,d)    - Read a pattern register pattern register
**                                is put in buffer and in WORD variable
**                                d
**      NEEDLAM(b,c,n)          - Indicate that LAM from given slot is needed.
**      IFTIMEOUT(maxloop)      - Loops maxloop times (>10us/pass) waiting for
**                                lams.  THen looks like IF statment, but
**                                condition is that a timeout has occured.
**      Example use of bit register functions:
**
**      LOGICAL timeout;
**      WORD    brg;
**      ..
**      READDBIT(0,1,20,0,0,brg);
**          ..
**      BEGINLAM
**        IF(IAND(brg, 0x1))NEEDLAM(0,2,3);
**        IF(IAND(brg, 0x2))NEEDLAM(0,2,4);
**        if(IAND(brg, 0x3))NEEDLAM(0,2,5);
**        IFTIMEOUT(100) THEN
**          timeout = TRUE;
**          ENDDO
**        ELSE
**          timeout = FALSE;
**        ENDIF
**      ENDLAM
**
**                  Device specific pseudoroutines:
**      Several device specific in-line routines are defined to make the
**  handling of more common devices easier.  Devices not supported in this set
**  can be managed with the primitive CAMAC operations. NOTE: clear functions
**  are provided for modules which can be front panel cleared just in case 
**  there is the need to clear them from CAMAC as well.
**
**    See the header macros.h for more information.
**
**          User parameters:
**
**      The front end includes three pre-defined arrays:
**
**          INTEGER userints[]  - Front end integer parameters.
**          LOGICAL userflags[] - Front end flag parameters
**          REAL    userreals[] - Front end real paraemters.
**
** End of instructions... but look for more later in the file.
*/
extern INT16 second;
extern ReadoutStateMachine* gpStateMachine;

// The following objects constitute the configurable readout engine:

CTCLInterpreter*      pInterp(0);       // TCL interpreter.
CDigitizerDictionary* pDictionary(0);   // Dictionary of modules.
CReadOrder*           pReader(0);       // The readout engine.
CModuleCommand*       pCreator(0);      // Module creational. 
CCAENV775Creator*     p775(0);          // Creator for V775.
CCAENV785Creator*     p785(0);          // Creator for V785.
CCAENV792Creator*     p792(0);          // Creator for V792.
CPacketCreator*       pPacket(0);       // Creator for subpackets.

// The following constitute the configurable scaler readout engine.

CDigitizerDictionary* pScalers(0);      // Dictionary of scaler modules
CReadOrder*           pScalerRead(0);   // Reader for scalers.
CModuleCommand*       pScalerCreator(0); // Creates scaler modules.
CCAENV830Creator*     p830(0);          // Creates CAEN V830 scalers.
void DestroyConfigurator()
{
  // Clean up prior incarnations.

  // The Event readout infrastructure...

  //  a minor memory leak so they can run.

  // if(pInterp)     delete pInterp; // Causes deletion of objects too.
  // if(pCreator)    delete pCreator;
  // if(pReader)     delete pReader;
  // if(pDictionary) delete pDictionary;
  // if(p775)        delete p775;
  // if(p785)        delete p785;
  // if(p792)        delete p792;


  pCreator    = 0;
  pReader     = 0;
  pDictionary = 0;
  pInterp     = 0;
  p775        = 0;
  p785        = 0;
  p792        = 0;
  pPacket     = 0;


  // The Scaler readout infrastructure

  //  if(pScalers)        delete pScalers;
  //  if(pScalerRead)     delete pScalerRead;
  //  if(pScalerCreator)  delete pScalerCreator;
  //   if(p830)            delete p830;

  pScalers       = 0;
  pScalerRead    = 0;
  pScalerCreator = 0;
  p830           = 0;

}

void InitializeConfigurator()
{
  DestroyConfigurator();

  // Instantiate and link together new config system.

  // Make a new interpreter:

  pInterp = new CTCLInterpreter();
  Tcl_Init(pInterp->getInterpreter());
  pInterp->Eval("set Readout true"); // Indicate this is readout.

  // Create the readout module creation/readout infrastructure:

  pDictionary = new CDigitizerDictionary;
  pReader     = new CReadOrder(pInterp, pDictionary);
  pCreator    = new CModuleCommand(pInterp,
                                   pDictionary);

  // Register the event module creators with the module command:

  pCreator->AddCreator(p775 = new CCAENV775Creator);
  pCreator->AddCreator(p785 = new CCAENV785Creator);
  pCreator->AddCreator(p792 = new CCAENV792Creator);
  pCreator->AddCreator(pPacket = new CPacketCreator("packet",pDictionary));

  // Create the scaler module creation/readout infrastructure:

  pScalers       = new CDigitizerDictionary;
  pScalerRead    = new CReadOrder(pInterp, pScalers, 
                                  string("scalerbank"));
  pScalerCreator = new CModuleCommand(pInterp,
                                      pScalers,
                                      string("scaler"));

  // Register the scaler modules with the scaler command.

  pScalerCreator->AddCreator(p830 = new CCAENV830Creator);

}

void SourceScript(CTCLInterpreter* pInterp, const string& rPath)
{
  pInterp->EvalFile(rPath);
}



/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      initevt - This function contains code which indicates how to initialize
**                the CAMAC system for event readout.
**
**
**--
*/
extern string    SetupFile;
CNullBusy*       pBusy(0);

void
initevt ()
{
/*
**  INSTRUCTIONS:
**  -------------
**
**      Fill in the area below the end of these instructions, but before the
**      curly bracket with code that initializes devices in the event readout
**      section of the device.  Typically what's needed here is to first
**      put all crates on-line and initialize them, and then to clear all
**      digitizers and initialize any programmable devices.  If you have
**      more than one branh highway (not just branch 0), you should initialize
**      that as well before touching crates on that branch. The routine provided
**      shows how to initialize two empty crates on branch 0.  This initializer
**      is the first of the initializers called so it's not a bad idea to do
**      all crate initializations here, unless the crates are functionally
**      broken up.  A bit register is also initialized.  See the #define
**      statments below to tailor the location of that bit register.
**  End instructions... but watch for more further down */

  cerr << "Initializing Readout Engine\n";
  InitializeConfigurator();

                           

  try {
    cerr << "Processing setup file: " << SetupFile << endl;
    SourceScript(pInterp, SetupFile);

    pReader->Initialize();      // config modules.
    pReader->Clear();           // Always clear at start.

  }
  catch (CTCLException except) {
    CTCLVariable traceback(pInterp,
                           string("errorInfo"),
                           false);
    cerr << "Error in configuration script: ";
    cerr << except.ReasonText() << endl;
    cerr << traceback.Get(TCL_GLOBAL_ONLY) << endl;
    cerr << "1. Stop the run\n";
    cerr << "2. Fix the setup file\n";
    cerr << "3. Start the run again\n";
    DestroyConfigurator();
    return;
  }
  catch (string except) {
    cerr << "An exception was caught probably while";
    cerr << "Initalizing a module:\n";
    cerr << "   " << except << endl;
    cerr << "1.   Stop the run\n";
    cerr << "2.   Correct the setup file\n";
    cerr << "3.   Start the run again\n";
    DestroyConfigurator();
    return;
  }
  catch (...) {
    cerr << "An unexpected exception was caught in ";
    cerr << "initevt().  Probably there's an unforeseen ";
    cerr << "problem in your configuration script.\n";
    cerr << "Sorry I can't be more specific.\n";
    cerr << "   1. Stop the run\n";
    cerr << "   2. Examine the configuration script carefully\n";
    cerr << "   3. Fix any errors you find.\n";
    cerr << "   4. Start the run again.\n";
    DestroyConfigurator();
    return;

  }

}



/*
/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      initrig1    - This section should be filled in to initialize CAMAC
**                    modules associated with user trigger 1.
**
**--
*/
void
initrig1 ()
{

/*
**  Instructions:
**  -------------
**
**      The section of code between the end of this comment and the the }
**      should be filled in with code that initializes all hardware associated
**      with user trigger1.  This trigger SHOULD NOT BE ENABLED AT THIS TIME
**      since this routine is called at power up as well as at run start.
**      The trigger should only be enabled in trig1ena().
**      The sample provided takes no action to initialize trigger 1.
** End of instructions, but there's more later...                   */

    
}



/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      iniscl  - Initialize scaler readout.
**
**
**  IMPLICIT INPUTS:
**
**      The special variable numscalers is the number of scalers.
**
**--
*/
void
iniscl ()
{
/*
**  Instructions:
**  -------------
**      This function is called to intialize all scaler modules in the
**      system.  There is a pre-declared variable 'numscalers' which 
**      contains the number of scalers in the system.  The sample code below
**      is written to deal with either a block of 12 channel scalers (LRS2551)
**      or a block of 32 channel scalers (LRS4434), depedning on the definition
**      of the constant SCALER_CHANNELS.  If SCALER_CHANNELS is 12, then
**      code is generated for LRS2551, if SCALER_CHANNELS is 32, then for
**      LRS4434.  Several notes:
**          1. The code below demonstrates the use of C's #define statement
**             for generating symbolic constants (like FORTRAN parameters).
**             Note that #defines must start in column 1.
**          2. The code below demonstrates the use of C's #if statement to
**             do conditional compilation.  There is a big difference between
**            #if and IF. #if controls what code is generated, while
**            IF controls what code is executed.  The false side of the
**            #if statement doesn't exist and therefore cannot be used
**            to do run time control flow.
**          3. If all the user wants to do is modify the starting scaler,
**            or the type of scaler, then the definitions below are all
**            that need to be changed.  More complex changes require coding.
**          4.The % operator is the modulus operator, that is (a % b) is the
**            same as FORTRAN's MOD(A,B).
**          5. Advanced note. #define creates things called MACRO's a MACRO
**             is a stored series of text which is expanded in line when it
**             is invoked.  MACROs can have parameters just like functions
**             and this is how the psuedo functions and FORTRAN like syntax
**             has been layered on to C.  For example, if you would like
**             to define a FORTRAN like MOD pseudo function, then:
**             12345678901234567890123456789012345678901234567890 <- Column
**             #define MOD(a,b)  ((a) % (b))
**  End of instructions for now...                                  */



  try {
    if(pScalerRead) {
      pScalerRead->Initialize();
      pScalerRead->Clear();
      
      // Figure out how many scalers we have and set the scaler count.
      
      char buffer[8192];
      int nWords = pScalerRead->Read(buffer); //  do a test read.
      daq_SetScalerCount(nWords*sizeof(short)/sizeof(long));
      pScalerRead->Clear();
    }
  }
  catch (CTCLException except) {
    CTCLVariable traceback(pInterp,
                           string("errorInfo"),
                           false);
    cerr << "Error in configuration script: ";
    cerr << except.ReasonText() << endl;
    cerr << traceback.Get(TCL_GLOBAL_ONLY) << endl;
    cerr << "1. Stop the run\n";
    cerr << "2. Fix the setup file\n";
    cerr << "3. Start the run again\n";
    DestroyConfigurator();
    return;
  }
  catch (string except) {
    cerr << "An exception was caught probably while";
    cerr << "Initalizing a module:\n";
    cerr << "   " << except << endl;
    cerr << "1.   Stop the run\n";
    cerr << "2.   Correct the setup file\n";
    cerr << "3.   Start the run again\n";
  }
  catch (...) {
    cerr << "An unexpected exception was caught in ";
    cerr << "initevt().  Probably there's an unforeseen ";
    cerr << "problem in your configuration script.\n";
    cerr << "Sorry I can't be more specific.\n";
    cerr << "   1. Stop the run\n";
    cerr << "   2. Examine the configuration script carefully\n";
    cerr << "   3. Fix any errors you find.\n";
    cerr << "   4. Start the run again.\n";
    DestroyConfigurator();    
  }


}


/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      clearevt    - Clear user events.
**
**
**--
*/
void
clearevt ()
{
/*
**  Instructions:
**  -------------
**      This routine should be filled in with the actions needed to clear
**      all digitizers associated with the primary event.  Note that after
**      the readout, of an event, a standard NIM-out is written to with all
**      1's.  This is done in time suitable for clearing devices with front
**      panel clears.  The user need not clear devices which are cleared via
**      this signal.
**      The sample code does nothing.
**  End of instructions... but there's more.                */
    
  if(pReader)
    pReader->Prepare();
}



/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      clrtrig1    - This function is called when a user 1 trigger read out is 
**                    complete.
**
**
**--
*/
void
clrtrig1 ()
{
/*
**  Instructions:
**  -------------
**      This function is called to clear the user1 trigger devices.  This
**      should not be used to disable triggers, since we are called at the end
**      of every trigger 1 event.  The entry trig1dis should be used instead.
**      Note when clearing trigger 1 devices, it is assumed that there need not
**      be any connection between trigger 1 and the 'event' trigger.  Therefore,
**      the front panel NIM out clear register is not written to by the uppler
**      levels of the system and must be written to by the user if that's 
**      desired.
**          The sample code below does nothing.
**      End of Instructions for now...                                      */ 
    
}



/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      clrscl  - Clear scalers
**
**
**--
*/
void
clrscl ()
{
/*
**  Instructions:
**  -------------
**      This function is called to clear the scalers following readout, on 
**      run start and on run resume.  The sample code below is intended for 
**      use with the sample code given in iniscl(), that is we can deal
**      with either a contiguous block of 32 or 12 channel scalers.
**  End of instructions for now....                             */

  if(pScalerRead) {
    pScalerRead->Prepare();
  }
    
}


/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      readevt - This function is called to read an event.
**
**  FORMAL PARAMETERS:
**
**      INT16 *bufpt    - Pointer to buffer to fill.
**
**
**  FUNCTION VALUE:
**
**      Number of words read.
**
**--
*/
WORD
#ifdef __unix__
readevt (DAQWordBufferPtr& bufpt)
#else 
readevt (WORD* bufpt)
#endif
{
#ifdef __unix__
    DAQWordBufferPtr _sbufpt = bufpt;
#else
    WORD *_sbufpt = bufpt;
#endif
    LOGICAL reject;

    reject   = FALSE;
    {    
/*------------------------- Begin user code. ----------------------------*/
/*
**  Instructions:
**  -------------
**      This routine must be filled in with code that indicates how to perform
**      the event readout.  Digitizers need not be cleared after readout,
**      that's done by a call back down here to clearevt().  Some points of
**      interest:
**          1. the predefined array _sbufpt can be used to reference the
**             buffer after words have been read, that is, _sbufpt[0] is
**             the first word you read.
**          2. The predefined logical variable reject can be set to TRUE to
**             inform the system that the event is to be thrown away.
**          3. The data the user reads will be prefaced by the system with
**             a word count.
**          The sample code below is a skeleton which cracks a single 16
**          bit register, waits for indicated lams for each bit and then
**          does the read out on the set bits in the register.  If a LAM timeout
**          occured, then the top bit of the bit register is set in the buffer
**          and the readout procedes.  Note the use of #defines to tailor
**          the location of the bit register, the LAM's expected for each bit,
**          and the bits that are actually used in the register.
**          Note how conditional compilation is used to remove tests for bits
**          which are not used by the experiment.
**          Note the use of the pre-defined 2-d array _lammsk in the LAM
**          decoding code below.  Setting the bits all at once is faster
**          than one at a a time (via NEEDLAM).  Note also the difference
**          in the way C addresses 2-d arrays.  The predefined array _lammsk
**          is an array of branch/crate lam masks.
**  End of instructions for now...                              */

      if(pReader) {

        // If he wants to he can turn on packetization in the reader!!

        pReader->Read(bufpt);
      }


/*-------------------------  End of user code. ---------------------------*/
}
    IF(reject) return 0;
#ifdef __unix__
    return bufpt.GetIndex() - _sbufpt.GetIndex();
#else
    return (bufpt - _sbufpt);
#endif
}



/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      readscl  - Read out scalers.
**
**  FORMAL PARAMETERS:
**
**      UINT32 *bufpt           - buffer pointer.
**      int numscalers          - Number of scalers to read out.
**

**
**
**--
*/
UINT16
readscl (UINT32* buffer,int numscalers)
{
    UINT32* _sbufpt = buffer;
    UINT16*  bufpt  = (UINT16*)buffer;



    {
/*
**  Instructions:
**  -------------
**
**      This section of code must be filled in to read out scalers into a buffer
**      provided by the caller.  The special predeclared array INTEGER _sbufpt[]
**      allows access to the buffer contents by longword number.
**      The sample code below continues the examples of scaler handling shown
**      so far.  If 12 channel scalers are used, we read them out assuming
**      that we've got a contiguous block of them.
**      If 32 channel scalers are used, then we use them instead.
**      The predefined INTEGER numscalers is the number of scaler channels
**      to be read out (set by SET SCALERS command).
**        NOTES:
**          1. After the scalers have been read out, the upper levels of code
**              will call the scaler clear routine so it is not necessary
**              to clear scalers at this level.
**          2.  Do not molest the code below the dashed line as it is necessary
**              to the correct operation of the system.
** End of instructions for now:                         */

 
      if(pScalerRead) {
        int nWords = pScalerRead->Read(buffer);
        bufpt +=  nWords;
      }


/*-------------------------------END USER CODE ---------------------------*/
    }



    
     
    return (UINT16)((UINT32)bufpt - (UINT32)_sbufpt);
}



/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      trig1dis    - Disable trigger 1 triggers.
**
**
**--
*/
void
trig1dis ()
{

/*
** NOTE:
**    >>>>User triggers are not supported in the UNIX readout system<<<<
**  Instructions:
**  -------------
**      The code below is used to turn off user triggers.  At present, the only
**      sort of user triggers supported are time periodic user triggers for
**      user trigger 1.  User triggers are intended to trigger readout events
**      that are not necessarily part of the normal set of event triggers.
**      These might be triggers to readout calibration systems or other
**      monitoring systems.
**        The sample code below is compiled if the #define for USERTRIG1_ENABLE
**      is set to be true.  In that case, the frequency and eventy type produced
**      for user triggers is controlled by the #define statements for
**      USER1_PERIOD    (INTEGER seconds between triggers) and:
**
**  End of instructions for now:    */

#ifndef __unix__
#define USERTRIG1_ENABLE        FALSE           /* TRUE if triggers desired */
#define USERTRIG1_PERIOD        -1              /* Seconds between triggers */

#if USERTRIG1_ENABLE

    STOPUSR1TRIG();
    
#endif
#endif
}



/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      trig1ena    - This function is called when user triggers are to be
**                    enabled.
**
**
**--
*/
void
trig1ena ()
{
/*
**  NOTE:
**     >>>>User triggers are not supported in the UNIX environment<<<<
**  Instructions:
**  -------------
**      This section of code should be filled in to enable user triggers.
**  The sample code continues the example begun for trig1dis.
**  End of instructions for now:        */
#ifndef __unix__
INTEGER period;


#if USERTRIG1_ENABLE
    IF(USERTRIG1_PERIOD LE 0) THEN
        msg("FATAL - Trigger frequency less than zero in trig1ena()");
        newline; newline;
        die();
    ENDIF

    STARTUSR1TRIG(USERTRIG1_PERIOD);

#endif
#endif
}



/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      rdtrig1 - Read out a user trigger.
**
**  FORMAL PARAMETERS:
**
**      INT16 *buffer   - Pointer to buffer to readout.
**
*/
int 
rdtrig1 (WORD* bufpt)
{
    WORD *_sbufpt;

    _sbufpt = bufpt;
    {
/*
**  NOTE:
**    >>>>The UNIX environment does not support user triggers <<<<
**  Instructions:
**  -------------
**      This area should be filled in with code that manages the readout of a
**      user 1 trigger.  The sample code below assumes that if user triggers are
**      enabled, you will want to trigger an action via setting a bit in a NIM
**      out register. 
**        The default event type of the event being read out
**      is USERBUF1 (32).  If not data is read into the buffer, then no event
**      is generated.  Similarly, if the function returns the value zero, then
**      no event is generated.
**      NOTE:
**          1.  The special variable bufpt is a 'pointer' to the event buffer.
**          2.  As before, the predeclared variable WORD _sbufpt[] gives
**              you a way to modify the buffer after readout (e.g. put in
**              a special bit in the bit register.
**          3.  The defines for NIMOUT_xxx allow the CAMAC location of the
**              nimout to be defined, as well as the bit that's actually
**              fired off.
**  End of instructions for now...                  */
#ifndef __unix__
#define NIMOUT_BRANCH   0                           /* Branch nimout is in */
#define NIMOUT_CRATE    2                           /* Crate nimout is in. */
#define NIMOUT_SLOT     20                          /* Slot nimout lives in */
#define NIMOUT_TRIG1    0x800                       /* Bit to set. */

#if USERTRIG1_ENABLE
        NIMOUT(NIMOUT_BRANCH, NIMOUT_CRATE, NIMOUT_SLOT, NIMOUT_TRIG1);

/* -------------------------- End user code. ----------------------- */
#endif
#endif

    }
    return (bufpt - _sbufpt);
}



/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      evtmax  - Returns the size of the largest physics event.
**
**  FUNCTION VALUE:
**
**      Largest number of words that can be read out by a physics trigger.
****--
*/
WORD 
evtmax ()
{

/*
**  Instructions:
**  -------------
**      Fill in the #define below to indicate the size of the largest
**      possible physics event in words.
**  End of instructions for now...          */

#define EVENT_MAXWORDS  40      /* Fill with correct size */

/*------------------------------ end of user code  -----------------------*/

    IF (EVENT_MAXWORDS LE 0) THEN           /* We crash the program if the */
                                            /* user didn't set the size */
        fprintf (stderr, "EVENT_MAXWORDS was not properly defined\n");
        fprintf (stderr, "Must be .GT. 0 was %d \n", EVENT_MAXWORDS);
#ifdef __unix__
        abort();
#else
        panic("BUGCHECK");
#endif
    ENDIF;
    return (EVENT_MAXWORDS);
}



/*
**++
**  FUNCTIONAL DESCRIPTION:
**
**      trig1max    - Returns the number of words readout in a user1 trigger.
**
**  FUNCTION VALUE:
**
**      Number of  words read out.
**
**
**--
*/
WORD 
trig1max ()
{
/*
** NOTE:
**    >>>>The UNIX environment does not support user triggers <<<<
**
**  Instructions:
**  -------------
**      This function should be filled in to indicate the maximum number
**      of words to be read out on a user trigger 1.  The sample code operates
**      as follows, if the #define'd constant USERTRIG1_ENABLE is FALSE, then
**      the value 0 is generated (no words read out), If USERTRIG1_ENABLE is
**      true, then the user should edit the definition of USERTRIG1_MAXWORDS
**      to reflect the largest number of words that can be read out in a
**      user1 trigger.  
**  End of all Instructions for now....                         */

#define USERTRIG1_MAXWORDS      0           /* Edit to reflect actual count */

#if USERTRIG1_ENABLE && (!defined(__unix__))
    IF (USERTRIG1_MAXWORDS LT 0) THEN
        fprintf (stderr, "USERTRIG1_MAXWORDS incorrectly initialized\n");
        fprintf (stderr, "Must be GE 0 was %d\n", USERTRIG1_MAXWORDS);
        die();
        return USERTRIG1_MAXWORDS;
    ENDIF;
#else
    return 0;
#endif    

}

---