Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

STILScanMatrix Class Reference

STILScanMatrix Class Interface. More...

#include <stilscanmatrix.h>

List of all members.

Public Member Functions

 STILScanMatrix ()
 STILScanMatrix (const STILScanMatrix &)
virtual ~STILScanMatrix ()
STILScanMatrixoperator= (const STILScanMatrix &)
void init ()
LONG normalize ()
LONG flatten ()
void print ()
LONG getMaxScanLength ()
void setScanStringType (LONG id, STILScanType st)
STILScanType getScanStringType (LONG id) const
char getCurrentScanWFC (LONG id) const
void moveToNextScanEvent (LONG id)
STILScanStringoperator[] (LONG id)


Detailed Description

STILScanMatrix Class Interface.


Constructor & Destructor Documentation

STILScanMatrix::STILScanMatrix  ) 
 

Default constructor.

Parameters:
 
Returns:

STILScanMatrix::STILScanMatrix const STILScanMatrix sm  ) 
 

Construct a STILScanMatrix object from another ScanMatrix obj.

Parameters:
sm ScanMatrix source to construct from
Returns:

STILScanMatrix::~STILScanMatrix  )  [virtual]
 

Destructor.

Parameters:
 
Returns:


Member Function Documentation

LONG STILScanMatrix::flatten  ) 
 

Flatten this scan matrix so that it only contains 'unique' states.

Parameters:
 
Returns:
void
In the case of validation, we dont need to evaluate the same WFC data over and over again, so flatten the scan chain to a chain of only the unique WFC states (plus the pre-shift & post-shift WFC data)

char STILScanMatrix::getCurrentScanWFC LONG  id  )  const
 

Get the current scan event for this signal ID.

Parameters:
id STIL signal ID of interest
Returns:
char

LONG STILScanMatrix::getMaxScanLength  ) 
 

Get the maximum scan length of all scan sstrings.

Parameters:
 
Returns:
void
NOTE: This may be longer than the actual number of shifts that occur on the data. It returns the longest scan string length. It doesnt return the shift count, because there may be data in the scan matrix even if there is a shift count of 0 (due to pre & post-shift WFC's in the matrix). So, this function is mainly used to query whether or not there is data in the matrix. Maybe a rename would be useful (to be something like 'hasData()'), along with a 'getShiftCount()' func??

STILScanType STILScanMatrix::getScanStringType LONG  i  )  const [inline]
 

Parameters:
 
Returns:

void STILScanMatrix::init void   ) 
 

Initialize this STILScanMatrix object.

Parameters:
 
Returns:

void STILScanMatrix::moveToNextScanEvent LONG  id  ) 
 

Move to the next scan event for this signal ID.

Parameters:
id STIL signal ID of interest
Returns:
void

LONG STILScanMatrix::normalize  ) 
 

Normalize this scan matrix to the maximum chain length pre-pad scanin's and post-pad scanout's.

Parameters:
 
Returns:
LONG The shift length
NOTE: This data substitution scheme was pulled from the description in 1450.0, Section 24.5 - outlined in Table 14.

STILScanMatrix & STILScanMatrix::operator= const STILScanMatrix arg  ) 
 

Equals operator.

Parameters:
arg (STILScanMatrix&)
Returns:
(STILScanMatrix&)

STILScanString & STILScanMatrix::operator[] LONG  id  ) 
 

Index operator (returns scan string for specified signal ID).

Parameters:
id STIL signal ID of interest
Returns:
(STILScanString &) - Reference to the underlying scan

void STILScanMatrix::print  ) 
 

Print this STILScanMatrix object.

Parameters:
 
Returns:
void

void STILScanMatrix::setScanStringType LONG  id,
STILScanType  st
 

Init the specified scan sstring and set the type.

Parameters:
id STIL signal ID of interest
st Type of scan (ScanIn/ScanOut/UndefinedScanType)
Returns:
void


The documentation for this class was generated from the following files:
This page last updated on 6 Jul 2007

SourceForge.net Logo