torc::generic::Simulate Class Reference

This class is to model simulate construct which is a named collection of simulation stimulus and responses statements and is used in the interface and contents of views. More...

#include <Simulate.hpp>

Inheritance diagram for torc::generic::Simulate:

Inheritance graph
[legend]
Collaboration diagram for torc::generic::Simulate:

Collaboration graph
[legend]

List of all members.

Public Types

typedef VisitorType< Simulate > Visitor

Public Member Functions

virtual void accept (BaseVisitor &inoutVisitor) throw (Error)
void addPortListAlias (const PortListAliasSharedPtr &inPortListAlias) throw (Error)
PortListAliasSharedPtr findPortListAlias (const std::string &inName) throw ()
void getPortListAliases (std::vector< PortListAliasSharedPtr > &outPortListAliases) const throw ()
void setPortListAliases (const std::vector< PortListAliasSharedPtr > &inPortListAliases) throw (Error)
void getAllApply (std::vector< ApplySharedPtr > &outAllApply) const throw ()
void setAllApply (const std::vector< ApplySharedPtr > &inAllApply) throw (Error)
void addApply (const ApplySharedPtr &inSource) throw (Error)
void getWaveValues (std::vector< WaveValueSharedPtr > &outWaveValues) const throw ()
void setWaveValues (const std::vector< WaveValueSharedPtr > &inWaveValues) throw (Error)
void addWaveValue (const WaveValueSharedPtr &inSource) throw (Error)
WaveValueSharedPtr findWaveValue (const std::string &inName) throw ()
template<typename _Action>
void applyOnAllPortListAlias (const _Action &action) throw (Error)
template<typename _Action>
void applyOnAllWaveValues (const _Action &action) throw (Error)

Private Member Functions

 Simulate (const Simulate &source) throw ()
Simulate & operator= (const Simulate &source) throw ()

Private Attributes

SymTab< std::string,
PortListAliasSharedPtr > 		mPortListAliasSymTab
SymTab< std::string,
WaveValueSharedPtr > 		mWaveValueSymTab
std::vector< ApplySharedPtr > mAllApply

Friends

class FactoryType< Simulate >

Classes

class  Factory

Detailed Description

This class is to model simulate construct which is a named collection of simulation stimulus and responses statements and is used in the interface and contents of views.

Definition at line 47 of file Simulate.hpp.

Member Typedef Documentation

typedef VisitorType<Simulate> torc::generic::Simulate::Visitor

Convenience class to visit a simulate

Definition at line 61 of file Simulate.hpp.

Member Function Documentation

void torc::generic::Simulate::accept ( BaseVisitor &  inoutVisitor  )  throw (Error) [virtual]

Recive a inoutVisitor to this class. The visit method of the inoutVisitor is called and a reference to this object is passed as a parameter. It has to be noted however, that a dynamic_cast is performed inside this method. If the cast fails, an appropriate exception is thrown by this method. This sitation can arise when the passed Visitor object does not inherit from the appropriate inoutVisitor specialization. See Visitor documentation for more details.

Parameters:
[in,out] inoutVisitor A reference to the inoutVisitor object
Exceptions:
Error Visitor type inappropriate for visiting this object or any other error thrown by the Visitor::throw() method.

Implements torc::generic::Visitable.

Definition at line 78 of file Simulate.cpp.

void torc::generic::Simulate::addPortListAlias ( const PortListAliasSharedPtr &  inPortListAlias  )  throw (Error)

Add a port list alias to the symbol table of port list alias. If an empty pointer is supplied, it returns without doing anything.

Parameters:
[in] inPortListAlias A pointer to a port list alias object.
Exceptions:
Error PortListAlias could not be added, empty PortListAlias name
Error PortListAlias already exists in simulate

Definition at line 101 of file Simulate.cpp.

PortListAliasSharedPtr torc::generic::Simulate::findPortListAlias ( const std::string &  inName  )  throw ()

Find a PortListAlias by name, in the symbol table of port list alias.

Parameters:
[in] inName String specifying the name of the PortListAlias.
Returns:
A pointer to the PortListAlias if found, an empty pointer otherwise.

Definition at line 155 of file Simulate.cpp.

void torc::generic::Simulate::getPortListAliases ( std::vector< PortListAliasSharedPtr > &  outPortListAliases  )  const throw () [inline]

Get all the PortListAlias of this simulation.

Parameters:
[out] outPortListAliases Vector of PortListAlias to be appended to

Definition at line 241 of file Simulate.hpp.

void torc::generic::Simulate::setPortListAliases ( const std::vector< PortListAliasSharedPtr > &  inPortListAliases  )  throw (Error)

Set all the PortListAlias of this simulation.

Parameters:
[in] inPortListAliases Vector of PortListAlias to be appended to

Definition at line 129 of file Simulate.cpp.

void torc::generic::Simulate::getAllApply ( std::vector< ApplySharedPtr > &  outAllApply  )  const throw () [inline]

Get all the apply objects.

Parameters:
[out] outAllApply Vector of apply objects to be appended to

Definition at line 252 of file Simulate.hpp.

void torc::generic::Simulate::setAllApply ( const std::vector< ApplySharedPtr > &  inAllApply  )  throw (Error)

Set all the apply objects.

Parameters:
[in] inAllApply Vector of apply objects to be appended to

Definition at line 193 of file Simulate.cpp.

void torc::generic::Simulate::addApply ( const ApplySharedPtr &  inSource  )  throw (Error)

Add an apply objects to the vector of apply objects.

Parameters:
[in] inSource Pointer to Apply object
Add an apply to the vector of Apply objects.

Parameters:
[in] inSource Pointer to Apply object to be appended to

Definition at line 174 of file Simulate.cpp.

void torc::generic::Simulate::getWaveValues ( std::vector< WaveValueSharedPtr > &  outWaveValues  )  const throw () [inline]

Get the vector of wave values.

Parameters:
[out] outWaveValues Vector of wave values to be appended to

Definition at line 263 of file Simulate.hpp.

void torc::generic::Simulate::setWaveValues ( const std::vector< WaveValueSharedPtr > &  inWaveValues  )  throw (Error)

Set the vector of wave values.

Parameters:
[in] inWaveValues Vector of wave values to be appended to

Definition at line 216 of file Simulate.cpp.

void torc::generic::Simulate::addWaveValue ( const WaveValueSharedPtr &  inSource  )  throw (Error)

Add a wave value to the symbol table of wave values.

Parameters:
[in] inSource Pointer to WaveValue to be appended to
Exceptions:
Error WaveValue could not be added, empty WaveValue name
Error WaveValue already exists in simulate
A dd a wave value to the symbol table of wave values.

Parameters:
[in] inSource Pointer to WaveValue to be appended to
Exceptions:
Error WaveValue could not be added, empty WaveValue name
Error WaveValue already exists in simulate

Definition at line 243 of file Simulate.cpp.

WaveValueSharedPtr torc::generic::Simulate::findWaveValue ( const std::string &  inName  )  throw ()

Find a WaveValue by name, in the symbol table of port list alias.

Parameters:
[in] inName String specifying the name of the WaveValue.
Returns:
A pointer to the WaveValue if found, an empty pointer otherwise.

Definition at line 273 of file Simulate.cpp.

template<typename _Action>
void torc::generic::Simulate::applyOnAllPortListAlias ( const _Action &  action  )  throw (Error) [inline]

Apply action on all PortListAlias.

Parameters:
[in] action Action to be applied

Definition at line 274 of file Simulate.hpp.

template<typename _Action>
void torc::generic::Simulate::applyOnAllWaveValues ( const _Action &  action  )  throw (Error) [inline]

Apply action on all WaveValues.

Parameters:
[in] action Action to be applied

Definition at line 293 of file Simulate.hpp.

The documentation for this class was generated from the following files:
Generated on Thu Oct 13 16:50:25 2011 for TORC by  doxygen 1.5.6