stilscanmatrix.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2006 International Business Machines Corporation
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.opensource.org/licenses/cpl1.0.php
 *
 * Contributors:
 *    Douglas Sprague, Joel Wheeler - initial API and implementation
 *
 *****************************************************************************/

#ifndef STILScanMatrix_H
#define STILScanMatrix_H

#include "stilcom.h"           // Common library
#include "stilscanstring.h"    // STIL Scan String interface
#include <vector>


//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILScanMatrix  {

  // - Public members
  public:

    // - Default constructor
    STILScanMatrix();

    // - Copy Constructor
    STILScanMatrix(const STILScanMatrix &);

    // - Destructor
    virtual ~STILScanMatrix();

    // - Assignment operator
    STILScanMatrix & operator=(const STILScanMatrix &);

    // - Initialize/reset this object
    void  init();

    // - Normalize all scan sstring to the same length
    //   Pre-pad all ScanIn pins and post-pad all ScanOut pins
    LONG  normalize();

    // - "Flatten" this scan down into just it's 'unique' states
    LONG flatten();

    // - Print contents of this scan matrix for debug purposes
    void  print();

    // - Get the maximum scan length for all scan sstrings in this matrix
    LONG getMaxScanLength();

    // - Get/Set the scan sstring type (ScanIn/ScanOut) for this signal ID
    void setScanStringType(LONG id, STILScanType st);
    STILScanType getScanStringType(LONG id) const;

    // - Get the current piece of scan data (WFC) for the given signal ID
    char getCurrentScanWFC(LONG id) const;

    // - Move to the next available scan event for the given signal ID
    void moveToNextScanEvent(LONG id);

    // - Reference a specific scan sstring based on the signal ID.
    STILScanString & operator[](LONG id);

  // - Private members
  private:

    LONG m_maxScanLength;               // maximum scan length
    std::vector<STILScanString *> m_ssVector; // vector of scan sstring poniters

};


//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline STILScanType STILScanMatrix::getScanStringType(LONG i) const {
  STILScanType retval = ScanDisabled;
  if (   m_ssVector.size() > i
      && m_ssVector[i] != NULL
     ) {
    retval = m_ssVector[i]->getScanType();
  }
  return retval;
}

#endif

---

This page last updated on 6 Jul 2007