DDEGetNToken.java example

Explorer
ptii-master
/* DDEGetNToken is a test class used to test the consumption of tokens
 and check relevant parameters.

 Copyright (c) 1998-2005 The Regents of the University of California.
 All rights reserved.
 Permission is hereby granted, without written agreement and without
 license or royalty fees, to use, copy, modify, and distribute this
 software and its documentation for any purpose, provided that the above
 copyright notice and the following two paragraphs appear in all copies
 of this software.

 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.

 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 ENHANCEMENTS, OR MODIFICATIONS.

 PT_COPYRIGHT_VERSION_2
 COPYRIGHTENDKEY


 */
package ptolemy.domains.dde.kernel.test;

import ptolemy.actor.Receiver;
import ptolemy.actor.TypedCompositeActor;
import ptolemy.data.IntToken;
import ptolemy.data.Token;
import ptolemy.data.expr.Parameter;
import ptolemy.domains.dde.kernel.DDEReceiver;
import ptolemy.domains.dde.kernel.DDEThread;
import ptolemy.domains.dde.kernel.TimeKeeper;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;

//////////////////////////////////////////////////////////////////////////
//// DDEGetNToken

/**
 DDEGetNToken is a test class used to test the consumption of tokens
 and check relevant parameters. DDEGetNToken can retrieve N tokens
 where 'N' is set in the constructor. For each token retrieved, the
 current time at the time of consumption and the actual consumed
 token can be queried. The queries can take place after the completion
 of Manager.run().


 @author John S. Davis II
 @version $Id$
 @since Ptolemy II 0.3
 @Pt.ProposedRating Red (davisj)
 @Pt.AcceptedRating Red (cxh)

 */
public class DDEGetNToken extends DDEGet {
    /**
     */
    public DDEGetNToken(TypedCompositeActor cont, String name)
            throws IllegalActionException, NameDuplicationException {
        super(cont, name);

        numTokens = new Parameter(this, "numTokens");
        numTokens.setToken(new IntToken(3));
    }

    /**
     */
    public DDEGetNToken(TypedCompositeActor cont, String name, int tokens)
            throws IllegalActionException, NameDuplicationException {
        this(cont, name);
        numTokens.setToken(new IntToken(tokens));
    }

    Parameter numTokens;

    ///////////////////////////////////////////////////////////////////
    ////                         public methods                    ////

    /**
     */
    public double getAfterTime(int cntr) {
        return _afterTimes[cntr];
    }

    /**
     */
    public double getBeforeTime(int cntr) {
        return _beforeTimes[cntr];
    }

    /**
     */
    public Token getToken(int cntr) {
        return _tokens[cntr];
    }

    public void initialize() throws IllegalActionException {
        _numTokens = ((IntToken) numTokens.getToken()).intValue();
        _tokens = new Token[_numTokens];
        _beforeTimes = new double[_numTokens];
        _afterTimes = new double[_numTokens];

        for (int i = 0; i < _numTokens; i++) {
            _beforeTimes[i] = -1.0;
            _afterTimes[i] = -1.0;
        }
    }

    /**
     */
    public void fire() throws IllegalActionException {
        int cnt = 0;

        while (cnt < _numTokens) {
            //System.out.println("##### " + cnt);
            boolean finished = false;
            Thread thread = Thread.currentThread();

            if (thread instanceof DDEThread) {
                TimeKeeper timeKeeper = ((DDEThread) thread).getTimeKeeper();
                _beforeTimes[cnt] = timeKeeper.getModelTime().getDoubleValue();

                Receiver[][] rcvrs = input.getReceivers();

                for (int i = 0; i < rcvrs.length; i++) {
                    for (int j = 0; j < rcvrs[i].length; j++) {
                        DDEReceiver rcvr = (DDEReceiver) rcvrs[i][j];

                        if (rcvr.hasToken()) {
                            // System.out.println("#####");
                            System.out
                                    .println("#####Past DDEGetNToken.rcvr.hasToken()");

                            // System.out.println("#####");
                            _tokens[cnt] = rcvr.get();

                            _afterTimes[cnt] = timeKeeper.getModelTime()
                                    .getDoubleValue();
                            cnt++;
                            j = rcvrs[i].length + 1;
                            finished = true;
                        }
                    }

                    if (finished) {
                        i = rcvrs.length + 1;
                    }
                }
            }
        }
    }

    ///////////////////////////////////////////////////////////////////
    ////                         private variables                 ////
    private int _numTokens;

    private Token[] _tokens = null;

    private double[] _beforeTimes = null;

    private double[] _afterTimes = null;
}