STIL Class Reference

STIL (Standard Test Interface Language) Class Interface. More...

#include <stil.h>

Inheritance diagram for STIL:

List of all members.

Public Types
enum	OPENMODE {   OPEN_READ = 1,   OPEN_WRITE = 2,   OPEN_NONE = 0 }
Public Member Functions
	STIL ()
	STIL (const STIL &)
	STIL (const sstring &fname, OPENMODE openmode=OPEN_READ, ULONG pat_buf_size=STIL_DEFAULT_PAT_BUF_SIZE)
	~STIL ()
STIL &	operator= (const STIL &)
void	init ()
void	open (const sstring &, OPENMODE openmode=OPEN_READ, ULONG pat_buf_size=STIL_DEFAULT_PAT_BUF_SIZE)
void	close ()
void	verify ()
ULONG	getPatternBufferSize () const
const sstring &	getVersion () const
void	setVersion (const sstring &)
LONG	getNumExtensions () const
BOOLEAN	hasExtension (const sstring &)
const STILExtension &	getExtension (LONG) const
void	addExtension (const STILExtension &)
const STILHeader *	getHeader () const
void	setHeader (const STILHeader &)
const STILSignals *	getSignals () const
void	setSignals (const STILSignals &)
void	addSignalGroups (const STILSignalGroups &)
void	addPatternBurst (const STILPatternBurst &)
void	addPatternExec (const STILPatternExec &)
void	addSpec (const STILSpec &)
void	addCategory (const STILCategory &)
void	addSelector (const STILSelector &)
void	addTiming (const STILTiming &)
void	addScanStructures (const STILScanStructures &)
void	addProcedures (const STILProcedures &)
void	addMacroDefs (const STILMacroDefs &)
STILPattern *	newPattern ()
LONG	getPatternRefCount (const sstring &pat)
STILEvalEngine *	getEvalEngine (const sstring &pat, LONG nth_reference=1)
void	destroyEvalEngine (const STILEvalEngine *)
Friends
class	STILEvalEngine

---

Detailed Description

STIL (Standard Test Interface Language) Class Interface.

The STIL Class is the high-level interface for reading & writing STIL files.

Note that this class is derived from a STILBlock class to allow it all the normal block capabilities of handling annotations and user keywords and iteration.

---

Member Enumeration Documentation

enum STIL::OPENMODE

Enumeration values: OPEN_READ  OPEN_WRITE  OPEN_NONE

---

Constructor & Destructor Documentation

STIL::STIL (   )

Default Constructor for a STIL object. Parameters: Returns:

STIL::STIL (  const STIL &  stil  )

Copy Constructor for a STIL object. Parameters: stil  Source object to construct this object from Returns:

STIL::STIL (  const sstring &  filename_arg, OPENMODE  omode = OPEN_READ, ULONG  pbsize = STIL_DEFAULT_PAT_BUF_SIZE )

Constructor a STIL object from a STIL filename. Parameters: filename_arg  Filename omode  Open mode (to open fstream) pbsize  Pattern buffer size (0 = no buffer). Sets # of pattern statements to keep loaded in memory at one time. Returns:

STIL::~STIL (   )

Destructor for a STIL object. Parameters: Returns:

---

Member Function Documentation

void STIL::addCategory (  const STILCategory &  category  )

Audit and add a new Category block to the list. Parameters: category  The Category object to audit/add Returns: (void)

void STIL::addExtension (  const STILExtension &  se  )

Add a STIL extensions to the list of used extensions. Parameters: se  The ext to add Returns: (void)

void STIL::addMacroDefs (  const STILMacroDefs &  macrodefs  )

Audit and add a new MacroDefs block to the list. Parameters: macrodefs  The MacroDefs object to audit/add Returns: (void)

void STIL::addPatternBurst (  const STILPatternBurst &  patburst  )

Audit and add a new PatternBurst to the list. Parameters: patburst  The PatternBurst to audit/add Returns: (void)

void STIL::addPatternExec (  const STILPatternExec &  patexec  )

Audit a add a new PatternExec to the list. Parameters: patexec  The PatternExec to audit/add Returns: (void)

void STIL::addProcedures (  const STILProcedures &  procedures  )

Audit and add a new Procedures block to the list. Parameters: procedures  The Procedures object to audit/add Returns: (void)

void STIL::addScanStructures (  const STILScanStructures &  scanstructures  )

Audit and add a new ScanStructures block to the list. Parameters: scanstructures  The ScanStructures object to audit/add Returns: (void)

void STIL::addSelector (  const STILSelector &  selector  )

Audit and add a new Selector block to the list. Parameters: selector  The Selector object to audit/add Returns: (void)

void STIL::addSignalGroups (  const STILSignalGroups &  sg  )

Add a SignalGroups block to this STIL object. Parameters: sg  ignalGroups block to add Returns: void

void STIL::addSpec (  const STILSpec &  spec  )

Audit and add a new Spec block to the list. Parameters: spec  The Spec object to audit/add Returns: (void)

void STIL::addTiming (  const STILTiming &  timing  )

Audit and add a new Timing block to the list. Parameters: timing  The timing object to audit/add Returns: (void)

void STIL::close (   )

Close the STIL object and do any cleanup processing. Parameters: Returns: (void)

void STIL::destroyEvalEngine (  const STILEvalEngine *  pEE  )

Clean up eval engine memory. Parameters: pEE  Ptr to the eval engine Returns:

STILEvalEngine * STIL::getEvalEngine (  const sstring &  pname, LONG  nth_reference = 1 )

Get an evaluation engine for a pattern's n'th reference within this STIL file. Parameters: pname  Pattern of interest nth_reference  N'th reference of Pattern (default 1) Returns: (STILEvalEngine*) - NULL if it couldnt be created

const STILExtension & STIL::getExtension (  LONG  e  )  const

Get one of the currently loaded STIL extensions. Parameters: e  Which of the extensions to get Returns: STILExtension

const STILHeader * STIL::getHeader (   )  const [inline]

Parameters: Returns:

LONG STIL::getNumExtensions (   )  const

Get number of STIL extensions. Parameters: Returns: LONG - # STIL extensions loaded

ULONG STIL::getPatternBufferSize (   )  const [inline]

Parameters: Returns:

LONG STIL::getPatternRefCount (  const sstring &  pname  )

Get # of references to this Pattern in PatList, PatternBurst,... Parameters: pname  Pattern of interest Returns: (LONG) - # of references to this Pattern

const STILSignals * STIL::getSignals (   )  const [inline]

Parameters: Returns:

const sstring & STIL::getVersion (   )  const [inline]

Parameters: Returns:

BOOLEAN STIL::hasExtension (  const sstring &  ext  )

See whether or not a certain extension exists in the STIL. Parameters: ext  The ext to check for Returns: BOOLEAN - TRUE if matching extension is found

void STIL::init (   )

Initialize the STIL object. Parameters: Returns: (void)

STILPattern * STIL::newPattern (   )

Allocate a new Pattern block within this STIL object. Parameters: Returns: (STILPattern *) ptr to newly allocated Pattern block

void STIL::open (  const sstring &  fname, OPENMODE  omode = OPEN_READ, ULONG  pbsize = STIL_DEFAULT_PAT_BUF_SIZE )

Open a STIL file as either READ or WRITE. Parameters: fname  STIL filename to use for open omode  Mode for opening the file stream pbsize  Pattern buffer size (0 = no buffer) Returns: (void)

STIL & STIL::operator= (  const STIL &  stil  )

Assignment operator. Parameters: stil  Source object to assign this object from Returns: (STIL&)

void STIL::setHeader (  const STILHeader &  header_arg  )

Set the Header block for this STIL object. Parameters: header_arg  New Header object to set Returns: (void)

void STIL::setSignals (  const STILSignals &  signals_arg  )

Set the Signals block for this STIL object. Parameters: signals_arg  New Signals block to set Returns: (void)

void STIL::setVersion (  const sstring &  v  )  [inline]

Parameters: Returns: (void)

void STIL::verify (   )

Verify the STIL object for syntax & semantics. Parameters: Returns: (void)

---

Friends And Related Function Documentation

friend class STILEvalEngine [friend]

---

The documentation for this class was generated from the following files:

• stil.h
• stil.cpp

---

This page last updated on 6 Jul 2007