STILSignalBlock Class Reference

STILSignalBlock Class Interface. More...

#include <stilsignalblock.h>

Inheritance diagram for STILSignalBlock:

List of all members.


Public Types
typedef WFCSTranslateStruct	WFCSTranslator
enum	STILDefaultState { UndefinedDefaultState, ForceUp, ForceDown, ForceOff }
enum	STILBase { UndefinedBase, Hex, Dec }
enum	STILAlignment { UndefinedAlignment, MSB, LSB }
Public Member Functions
	STILSignalBlock ()
	STILSignalBlock (Type)
	STILSignalBlock (const STILSignalBlock &)
virtual	~STILSignalBlock ()
STILSignalBlock &	operator= (const STILSignalBlock &)
void	init ()
void	setTermination (STILTermination)
STILTermination	getTermination () const
void	setDefaultState (STILDefaultState)
STILDefaultState	getDefaultState () const
void	setBase (STILBase b, const STILWFCS &wfcs)
STILBase	getBase () const
const STILWFCS &	getBaseWFCS () const
LONG	getBaseNumBits () const
void	setAlignment (STILAlignment)
STILAlignment	getAlignment () const
void	setScanIn (LONG length)
LONG	getScanIn () const
void	setScanOut (LONG length)
LONG	getScanOut () const
void	setDataBitCount (LONG count)
LONG	getDataBitCount () const
void	print_vectortrans () const
void	print_vectortrans (std::ofstream &ttofs) const
char	evalTrans (sstring &, LONG ln=0) const
Static Public Member Functions
const sstring &	convertTermination (STILTermination)
const sstring &	convertDefaultState (STILDefaultState)
const sstring &	convertBase (STILBase)
const sstring &	convertAlignment (STILAlignment)
Protected Member Functions
const sstring	WFC2Bin (const char) const
const sstring	Bin2WFC (const sstring) const
Protected Attributes
STILTermination	m_termination
STILDefaultState	m_defaultState
STILBase	m_base
STILWFCS	m_baseWFCS
STILAlignment	m_alignment
LONG	m_scanin
LONG	m_scanout
LONG	m_databitcount
int	m_numbits
std::vector< WFCSTranslator >	m_WFCSTransVec
Friends
std::ostream &	operator<< (std::ostream &os, const STILSignalBlock &)

Detailed Description

STILSignalBlock Class Interface.

The STILSignalBlock class is a base class from which all Signal-like objects are derived from (i.e. Signal, SignalGroup).

Member Typedef Documentation

typedef struct WFCSTranslateStruct STILSignalBlock::WFCSTranslator

Member Enumeration Documentation

enum STILSignalBlock::STILAlignment

Enumeration values:

UndefinedAlignment Never set.

MSB Most Significant bit aligned.

LSB Least Significant bit aligned.

enum STILSignalBlock::STILBase

Enumeration values:

UndefinedBase Never set.

Hex Hex eval base.

Dec Dec eval base.

enum STILSignalBlock::STILDefaultState

Enumeration values:

UndefinedDefaultState Never set.

ForceUp Stim-1.

ForceDown Stim-0.

ForceOff Off.

Constructor & Destructor Documentation

STILSignalBlock::STILSignalBlock ( )

Default Constructor for a STILSignalBlock object.

Parameters:

Returns:

STILSignalBlock::STILSignalBlock ( Type t )

Construct a STILSignalBlock object given a STILEntity::Type.

Parameters:

t STILEntity::Type

Returns:

STILSignalBlock::STILSignalBlock ( const STILSignalBlock & st )

Constructor a STILSignalBlock object from another STILSignalBlock.

Parameters:

st STILSignalBlock object to construct from

Returns:

STILSignalBlock::~STILSignalBlock ( ) [virtual]

Destructor for a STILSignalBlock object.

Parameters:

Returns:

Member Function Documentation

const sstring STILSignalBlock::Bin2WFC ( const sstring ) const [protected]

const sstring & STILSignalBlock::convertAlignment ( STILAlignment u ) [static]

Convert a Alignment enumeration to a sstring equivilant.

Parameters:

u Alignment enumeration

Returns:
(const sstring &)

const sstring & STILSignalBlock::convertBase ( STILBase b ) [static]

Convert a Base enumeration to a sstring equivilant.

Parameters:

b Base enumeration

Returns:
(const sstring &)

const sstring & STILSignalBlock::convertDefaultState ( STILDefaultState ds ) [static]

Convert a DefaultState enumeration to a sstring equivilant.

Parameters:

df DefaultState enumeration

Returns:
(const sstring &)

const sstring & STILSignalBlock::convertTermination ( STILTermination t ) [static]

Convert a Termination enumeration to a sstring equivilant.

Parameters:

t Termination enumeration

Returns:
(const sstring &)

char STILSignalBlock::evalTrans ( sstring & tstr,

LONG linenum = 0

) const

Pass in a dec/hex string, translate to a WFC (alters the sstring&).

Parameters:

tstr The string to evaluate (** I/O parameter). Will be modified/

Returns:
(char) - the resultant WFC

STILSignalBlock::STILAlignment STILSignalBlock::getAlignment ( ) const [inline]

Parameters:

Returns:

STILSignalBlock::STILBase STILSignalBlock::getBase ( ) const [inline]

Parameters:

Returns:

LONG STILSignalBlock::getBaseNumBits ( ) const [inline]

Parameters:

Returns:

const STILWFCS & STILSignalBlock::getBaseWFCS ( ) const [inline]

Parameters:

Returns:

LONG STILSignalBlock::getDataBitCount ( ) const [inline]

Parameters:

Returns:

STILSignalBlock::STILDefaultState STILSignalBlock::getDefaultState ( ) const [inline]

Parameters:

Returns:

LONG STILSignalBlock::getScanIn ( ) const [inline]

Parameters:

Returns:

LONG STILSignalBlock::getScanOut ( ) const [inline]

Parameters:

Returns:

STILTermination STILSignalBlock::getTermination ( ) const [inline]

Parameters:

Returns:

void STILSignalBlock::init ( void )

Initialize the STILSignalBlock object.

Parameters:

Returns:
(void)

Reimplemented in STILSignal, and STILSignalGroup.

STILSignalBlock & STILSignalBlock::operator= ( const STILSignalBlock & st )

Assignment operator.

Parameters:

st Source object to assign this object from

Returns:
(STILSignalBlock&)

void STILSignalBlock::print_vectortrans ( std::ofstream & ttofs ) const

Print the array of WFCS and the binary sstring that they translate to. (For debugging use).

void STILSignalBlock::print_vectortrans ( ) const

Print the array of WFCS and the binary sstring that they translate to. (For debugging use).

void STILSignalBlock::setAlignment ( STILAlignment a ) [inline]

Parameters:

Returns:
(void)

void STILSignalBlock::setBase ( STILBase b,

const STILWFCS & wfcs

)

Set the SignalBlock base (WFCS, Hex, or Dec) and calculate the number of bits used to represent the WFCs, and come up with a list of possible Decimal-based WFC's.

Parameters:

b base

wfcs WFCSobject

Returns:
(void)

void STILSignalBlock::setDataBitCount ( LONG dbc ) [inline]

Parameters:

Returns:
(void)

void STILSignalBlock::setDefaultState ( STILDefaultState ds ) [inline]

Parameters:

Returns:
(void)

void STILSignalBlock::setScanIn ( LONG si ) [inline]

Parameters:

Returns:
(void)

void STILSignalBlock::setScanOut ( LONG so ) [inline]

Parameters:

Returns:
(void)

void STILSignalBlock::setTermination ( STILTermination t ) [inline]

Parameters:

Returns:
(void)

const sstring STILSignalBlock::WFC2Bin ( const char ) const [protected]

Convert a Hex/Dec based WFC into a binary.

Parameters:

wfc The WFC to convert from

Returns:
(const sstring) - the resultant binary