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

STILEntity Class Reference

STILEntity Class Interface. More...

#include <stilentity.h>

Inheritance diagram for STILEntity:

STILBlock STILSigRefExpr STILTimingWaveformRef STILWaveformEvent STILWFCS STILWFCSItem STIL STILCategory STILHeader STILHistory STILMacroDefs STILPatList STILPatternBlock STILPatternBurstBlock STILPatternExec STILProcedures STILScanChain STILScanStructures STILSelector STILSignalBlock STILSignalGroups STILSignals STILSpec STILSubWaveform STILSubWaveforms STILTerminations STILTiming STILVariable STILVectorBlock STILVectorItem STILWaveform STILWaveformItem STILWaveforms STILWaveformTable List of all members.

Public Types

enum  Type {
  UndefinedEntity,
  __SIMPLE__STIL__ENTITIES,
  Alignment,
  Ann,
  Base,
  BreakPoint,
  CategoryRef,
  DataBitCount,
  Date,
  DefaultState,
  ScanIn,
  ScanOut,
  Source,
  Start,
  Goto,
  X,
  Stop,
  IddqTestPoint,
  Title,
  Termination,
  UserKeywords,
  UserStatement,
  UserBlock,
  MacroDefsRef,
  PatternBurstRef,
  ProceduresRef,
  ScanStructuresRef,
  SelectorRef,
  SignalGroupsRef,
  TimingRef,
  WaveformTableRef,
  ScanChainRef,
  TimeUnit,
  ResourceTag,
  __COMPLEX__STIL__ENTITIES,
  Main,
  Terminations,
  Breakpoint,
  Call,
  Category,
  Condition,
  Fixed,
  Header,
  History,
  Infinite,
  Loop,
  Macro,
  MacroDefs,
  MacroDef,
  MatchLoop,
  PatList,
  Pattern,
  PatternBurst,
  PatternExec,
  Pattern_or_PatternBurst,
  Procedures,
  Procedure,
  Selector,
  Shift,
  Signals,
  Signal,
  SignalGroups,
  SignalGroup,
  ScanStructures,
  ScanChain,
  Timing,
  Variable,
  Vector,
  VectorItem,
  Spec,
  WaveformTable,
  SubWaveforms,
  SubWaveform,
  WaveformEvent,
  TimingWaveformRef,
  Waveforms,
  Waveform,
  WaveformItem,
  WFCS,
  WFCSItem,
  __END__STIL__ENTITIES
}

Public Member Functions

 STILEntity ()
 STILEntity (Type)
 STILEntity (const STILEntity &)
virtual ~STILEntity ()
STILEntityoperator= (const STILEntity &)
bool operator== (const STILEntity &) const
bool operator< (const STILEntity &) const
void init (Type t)
virtual void write (FILE *pOutFile, LONG indentation=0) const
const sstringgetName () const
void setName (const sstring &)
const sstringgetValue () const
void setValue (const sstring &)
Type getType () const
const sstring getTypeAsString () const
void setType (const Type)
const sstringgetLabel () const
void setLabel (const sstring &)
const sstringgetFileName () const
void setFileName (const sstring &)
LONG getLineNumber () const
void setLineNumber (LONG)
bool getSemanticErrors () const
void setSemanticErrors (bool)
bool isSimple () const
sstring getParseInfo () const

Protected Attributes

sstring m_name
sstring m_value
Type m_type
sstring m_label
sstring m_filename
LONG m_linenumber
bool m_semanticErrors

Detailed Description

STILEntity Class Interface.

The base class from which most all other STIL objects are derived.

Provides a common high-level interface for all STIL objects to allow building of heterogeneous collections of various STIL specific objects.

Also, provides common information related to various objects suchs as the filename and line number where this entity was parsed from a given STIL file. This is needed to give more accurate error messages related to semantics of STIL objects once they have already been parsed and errors have been found.


Member Enumeration Documentation

enum STILEntity::Type
 

Various Types of STIL objects.

Enumeration values:
UndefinedEntity  NOTE: Types are organized into two classes The first class is just simple type statements such as annotations and user statements. The second class of types are for complex block types which actually have derived classes that implement them such as signals, signalgroups,...
__SIMPLE__STIL__ENTITIES  Simple entities.
Alignment 
Ann 
Base 
BreakPoint 
CategoryRef 
DataBitCount 
Date 
DefaultState 
ScanIn 
ScanOut 
Source 
Start 
Goto 
X 
Stop 
IddqTestPoint 
Title 
Termination 
UserKeywords 
UserStatement 
UserBlock 
MacroDefsRef 
PatternBurstRef 
ProceduresRef 
ScanStructuresRef 
SelectorRef 
SignalGroupsRef 
TimingRef 
WaveformTableRef 
ScanChainRef 
TimeUnit 
ResourceTag 
__COMPLEX__STIL__ENTITIES  Complex entities.
Main 
Terminations 
Breakpoint 
Call 
Category 
Condition 
Fixed 
Header 
History 
Infinite 
Loop 
Macro 
MacroDefs 
MacroDef 
MatchLoop 
PatList 
Pattern 
PatternBurst 
PatternExec 
Pattern_or_PatternBurst 
Procedures 
Procedure 
Selector 
Shift 
Signals 
Signal 
SignalGroups 
SignalGroup 
ScanStructures 
ScanChain 
Timing 
Variable 
Vector 
VectorItem 
Spec 
WaveformTable 
SubWaveforms 
SubWaveform 
WaveformEvent 
TimingWaveformRef 
Waveforms 
Waveform 
WaveformItem 
WFCS 
WFCSItem 
__END__STIL__ENTITIES 

Reimplemented in STILWFCS.


Constructor & Destructor Documentation

STILEntity::STILEntity  ) 
 

Default Constructor for a STILEntity object.

Parameters:
 
Returns:

STILEntity::STILEntity Type  t  ) 
 

Construct given a Type.

Parameters:
t Type of entity
Returns:

STILEntity::STILEntity const STILEntity e  ) 
 

Copy Constructor for a STILEntity object.

Parameters:
e Source object to copy into this target object
Returns:

STILEntity::~STILEntity  )  [virtual]
 

Destructor for a STILEntity object.

Parameters:
 
Returns:


Member Function Documentation

const sstring & STILEntity::getFileName  )  const [inline]
 

Parameters:
 
Returns:
(const sstring &)

const sstring & STILEntity::getLabel  )  const [inline]
 

Parameters:
 
Returns:
(const sstring &)

LONG STILEntity::getLineNumber  )  const [inline]
 

Parameters:
 
Returns:

const sstring & STILEntity::getName  )  const [inline]
 

Return the name of this entity.

Parameters:
 
Returns:
(const sstring &)

sstring STILEntity::getParseInfo  )  const [inline]
 

Parameters:
 
Returns:
(const sstring &) A String containing the info about the source/line # of where this entity was generated

bool STILEntity::getSemanticErrors  )  const [inline]
 

Parameters:
 
Returns:

STILEntity::Type STILEntity::getType  )  const [inline]
 

Parameters:
 
Returns:

const sstring STILEntity::getTypeAsString  )  const
 

Convert the 'type' enumerated value to a.

Parameters:
 
Returns:
(const sstring) The type as a

const sstring & STILEntity::getValue  )  const [inline]
 

Get the value stored in this entity.

Parameters:
 
Returns:
(const sstring &)

void STILEntity::init Type  t  ) 
 

Initialize the STILEntity object.

Parameters:
t STILType
Returns:
(void)

Reimplemented in STILBlock.

bool STILEntity::isSimple  )  const [inline]
 

Parameters:
 
Returns:

bool STILEntity::operator< const STILEntity e  )  const
 

Less Than operator.

Parameters:
e Right hand side of < operator
Returns:
(bool)

STILEntity & STILEntity::operator= const STILEntity e  ) 
 

Assignment operator for a STILEntity object.

Parameters:
e Source object to assign into this target object
Returns:
(STILEntity&)

bool STILEntity::operator== const STILEntity e  )  const
 

Equality operator.

Parameters:
e Right hand side of == operator
Returns:
(bool)

void STILEntity::setFileName const sstring f  )  [inline]
 

Parameters:
 
Returns:
(void)

void STILEntity::setLabel const sstring l  )  [inline]
 

Parameters:
 
Returns:
(void)

void STILEntity::setLineNumber LONG  l  )  [inline]
 

Parameters:
 
Returns:
(void)

void STILEntity::setName const sstring n  )  [inline]
 

Set the name of this entity.

Parameters:
 
Returns:
(void)

void STILEntity::setSemanticErrors bool  s  )  [inline]
 

Parameters:
 
Returns:

void STILEntity::setType const   Type  )  [inline]
 

Parameters:
 
Returns:
(void)

void STILEntity::setValue const sstring v  )  [inline]
 

Parameters:
 
Returns:
(void)

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

Write the STILEntity object to a FILE.

Parameters:
pOutFile File to write out to
indentation To use when writing the block
Returns:
(void)

Reimplemented in STILBlock, STILCall, STILCategory, STILCondition, STILFixed, STILHeader, STILHistory, STILLoop, STILMacro, STILMacroDef, STILMacroDefs, STILPatList, STILPattern, STILPatternBurst, STILPatternBurstBlock, STILPatternExec, STILProcedure, STILProcedures, STILScanChain, STILScanStructures, STILSelector, STILShift, STILSignal, STILSignalGroup, STILSignalGroups, STILSignals, STILSigRefExpr, STILSpec, STILSubWaveform, STILSubWaveforms, STILTerminations, STILTiming, STILVariable, STILVector, STILVectorBlock, STILVectorItem, STILWaveform, STILWaveformEvent, STILWaveformItem, STILWaveforms, and STILWaveformTable.


Member Data Documentation

sstring STILEntity::m_filename [protected]
 

sstring STILEntity::m_label [protected]
 

LONG STILEntity::m_linenumber [protected]
 

sstring STILEntity::m_name [protected]
 

bool STILEntity::m_semanticErrors [protected]
 

Type STILEntity::m_type [protected]
 

sstring STILEntity::m_value [protected]
 


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

SourceForge.net Logo