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

STILPatternBurstBlock Class Reference

STILPatternBurst / PatList name and domain attributes Class Interface. More...

#include <stilpatternburstblock.h>

Inheritance diagram for STILPatternBurstBlock:

STILBlock STILEntity STILPatternBurst List of all members.

Public Types

enum  PAT_TERMINATION {
  TERMINATION_UNDEFINED = 0,
  TERMINATION_HIGH = 1,
  TERMINATION_LOW = 2,
  TERMINATION_OFF = 3,
  TERMINATION_UNKNOWN = 4
}

Public Member Functions

 STILPatternBurstBlock ()
 STILPatternBurstBlock (STILEntity::Type t)
 STILPatternBurstBlock (const STILPatternBurstBlock &)
virtual ~STILPatternBurstBlock ()
STILPatternBurstBlockoperator= (const STILPatternBurstBlock &)
void init ()
virtual void write (FILE *pOutFile, LONG indentation=0) const
void setStart (const sstring &label)
void setStop (const sstring &label)
void addSignalGroups (const sstring &name)
void addMacroDefs (const sstring &name)
void addProcedures (const sstring &name)
void addScanStructures (const sstring &name)
void addTermination (const STILTerminations &)

Protected Attributes

std::list< STILTerminationsm_termsList

Friends

std::ostream & operator<< (std::ostream &os, const STILPatternBurstBlock &)

Detailed Description

STILPatternBurst / PatList name and domain attributes Class Interface.

A PatternBurst contains a PatList block which identifies which Patterns to execute. Each Pattern name may be accompanied by domain specifications for various attributes. The purpose of this class is to capture the definition of a single PatList item.

At the highest level, a PatternBurst is also an item. It defines a name and has the identical domain specification capabilities. It also has the list of PatLists (a list of lists). Therefore, the PatternBurst also inherits this class.


Member Enumeration Documentation

enum STILPatternBurstBlock::PAT_TERMINATION
 

Enumeration values:
TERMINATION_UNDEFINED 
TERMINATION_HIGH 
TERMINATION_LOW 
TERMINATION_OFF 
TERMINATION_UNKNOWN 


Constructor & Destructor Documentation

STILPatternBurstBlock::STILPatternBurstBlock  ) 
 

Default Constructor for a STILPattternBurstBlock object.

Parameters:
 
Returns:

STILPatternBurstBlock::STILPatternBurstBlock STILEntity::Type  t  ) 
 

Constructor for a STILPatternBurstBlock object which sets the Entity type.

Parameters:
t STILType
Returns:

STILPatternBurstBlock::STILPatternBurstBlock const STILPatternBurstBlock arg  ) 
 

Constructor a STILPatternBurstBlock object from another STILPatternBurstBlock.

Parameters:
arg STILPatternBurstBlock object to construct from
Returns:
(void)

STILPatternBurstBlock::~STILPatternBurstBlock  )  [virtual]
 

Destructor for a STILPatternBurstBlock object.

Parameters:
 
Returns:


Member Function Documentation

void STILPatternBurstBlock::addMacroDefs const sstring name  )  [inline]
 

Parameters:
 
Returns:
(void)

void STILPatternBurstBlock::addProcedures const sstring name  )  [inline]
 

Parameters:
 
Returns:
(void)

void STILPatternBurstBlock::addScanStructures const sstring name  )  [inline]
 

Parameters:
 
Returns:
(void)

void STILPatternBurstBlock::addSignalGroups const sstring name  )  [inline]
 

Parameters:
 
Returns:
(void)

void STILPatternBurstBlock::addTermination const STILTerminations term  ) 
 

Add the STILTerminations object to a PatList/PatternBurst block.

Parameters:
term The Terminations object to add
Returns:
(void)

void STILPatternBurstBlock::init void   ) 
 

Initialize the STILPatternBurstBlock object.

Parameters:
 
Returns:
(void)

Reimplemented in STILPatternBurst.

STILPatternBurstBlock & STILPatternBurstBlock::operator= const STILPatternBurstBlock arg  ) 
 

Assignment operator for a STILPatternBurstBlock object.

Parameters:
arg Source object to assign into this target object
Returns:
(StilPatternBurstBlock &)

void STILPatternBurstBlock::setStart const sstring name  )  [inline]
 

Parameters:
 
Returns:
(void)

void STILPatternBurstBlock::setStop const sstring name  )  [inline]
 

Parameters:
 
Returns:
(void)

void STILPatternBurstBlock::write FILE *  pOutFile,
LONG  indentation = 0
const [virtual]
 

Write the STILPatternBurstBlock object to a FILE.

Parameters:
pOutFile FILE * of output file
indentation Current block indent in the output file
Returns:
(void)

Reimplemented from STILBlock.

Reimplemented in STILPatternBurst.


Friends And Related Function Documentation

std::ostream& operator<< std::ostream &  os,
const STILPatternBurstBlock
[friend]
 


Member Data Documentation

std::list<STILTerminations> STILPatternBurstBlock::m_termsList [protected]
 


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

SourceForge.net Logo