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:

Collaboration diagram for torc::generic::Simulate:

Data Structures
class	Factory

Public Types
typedef VisitorType< Simulate >	Visitor

typedef std::string	Name

typedef Simulate	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)

void	addPortListAlias (const PortListAliasSharedPtr &inPortListAlias) throw (Error)

PortListAliasSharedPtr	findPortListAlias (const std::string &inName)

void	getPortListAliases (std::vector< PortListAliasSharedPtr > &outPortListAliases) const

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

void	getAllApply (std::vector< ApplySharedPtr > &outAllApply) const

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

void	addApply (const ApplySharedPtr &inSource) throw (Error)

void	getWaveValues (std::vector< WaveValueSharedPtr > &outWaveValues) const

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

void	addWaveValue (const WaveValueSharedPtr &inSource) throw (Error)

WaveValueSharedPtr	findWaveValue (const std::string &inName)

template<typename _Action >
void	applyOnAllPortListAlias (const _Action &action) throw (Error)

template<typename _Action >
void	applyOnAllWaveValues (const _Action &action) throw (Error)

	~Simulate () throw ()

virtual const std::string	getName () const

void	setName (const std::string &inSource) throw (Error)

virtual Name	getOriginalName () const

virtual void	setOriginalName (const Name &inSource)

void	addComment (const std::string &comment)

const std::vector< std::string > &	getComments () const

void	setComments (const std::vector< std::string > &inSource)

void	setWeakThis (const WeakPointer &inWeakThis)

Pointer	getSharedThis () const

void	getUserData (std::list< std::string > &outUserData) const

void	setUserData (const std::list< std::string > &inSource)

void	addUserData (const std::string &inSource)

Protected Member Functions
	Simulate ()

Private Member Functions
	Simulate (const Simulate &source)

Simulate &	operator= (const Simulate &source)

Private Attributes
SymTab< std::string, PortListAliasSharedPtr >	mPortListAliasSymTab

SymTab< std::string, WaveValueSharedPtr >	mWaveValueSymTab

std::vector< ApplySharedPtr >	mAllApply

Friends
class	FactoryType< Simulate >

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 46 of file Simulate.hpp.

Member Typedef Documentation

typedef std::string torc::generic::Renamable::Name

inherited

Definition at line 40 of file generic/Renamable.hpp.

typedef boost::shared_ptr<Type> torc::generic::SelfReferencing< Simulate >::Pointer

inherited

Definition at line 36 of file SelfReferencing.hpp.

typedef Simulate torc::generic::SelfReferencing< Simulate >::Type

inherited

Definition at line 35 of file SelfReferencing.hpp.

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

Convenience class to visit a simulate

Definition at line 54 of file Simulate.hpp.

typedef boost::weak_ptr<Type> torc::generic::SelfReferencing< Simulate >::WeakPointer

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::Simulate::~Simulate	(	)
throw	(
	)

Definition at line 233 of file Simulate.cpp.

233 {}

torc::generic::Simulate::Simulate ( )

protected

Definition at line 229 of file Simulate.cpp.

                    : Nameable(), Renamable(), Commentable(), Visitable(),
     SelfReferencing<Simulate>(), UserDataContainer(), mPortListAliasSymTab(), mWaveValueSymTab(),
     mAllApply() {}

torc::generic::Simulate::Simulate ( const Simulate & source )

private

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 67 of file Simulate.cpp.

                                                              {
     try {
         runVisitor(*this, inoutVisitor);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

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 143 of file Simulate.cpp.

                                                                     {
     try {
         mAllApply.push_back(inSource);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

void torc::generic::Commentable::addComment ( const std::string & comment )

inherited

Add a comment to the object

Parameters

[in] comment The comment to add to an existing list of comments

Definition at line 36 of file Commentable.cpp.

                                                      {
     mComments.push_back(comment);
 }

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 85 of file Simulate.cpp.

                                                                                            {
     if(!inPortListAlias) {
         return;
     }
     std::string name = inPortListAlias->getName();
     if(name.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Empty port list alias name ", name);
         throw e;
     }
     if(false == mPortListAliasSymTab.set(name, inPortListAlias)) {
         Error e(eMessageIdErrorItemAlreadyExists, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Port list alias name", name);
         throw e;
     }
 }

Here is the call graph for this function:

void torc::generic::UserDataContainer::addUserData ( const std::string & inSource )

inherited

Add an user data to the list of user data

Parameters

[in] inSource An user data as string

Definition at line 34 of file UserDataContainer.cpp.

                                                              {
     mUserData.push_back(inSource);
 }

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 194 of file Simulate.cpp.

                                                                             {
     if(!inSource) {
         return;
     }
     std::string name = inSource->getName();
     if(name.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Empty WaveValue name ", name);
         throw e;
     }
     if(false == mWaveValueSymTab.set(name, inSource)) {
         Error e(eMessageIdErrorItemAlreadyExists, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("WaveValue name", name);
         throw e;
     }
 }

Here is the call graph for this function:

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 242 of file Simulate.hpp.

                   {
     try {
         mPortListAliasSymTab.applyOnAll(action);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

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 257 of file Simulate.hpp.

                   {
     try {
         mWaveValueSymTab.applyOnAll(action);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

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

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 127 of file Simulate.cpp.

                                                                           {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Empty PortListAlias name", inName);
         throw e;
     }
     PortListAliasSharedPtr portListAlias;
     mPortListAliasSymTab.get(inName, portListAlias);
     return portListAlias;
 }

Here is the call graph for this function:

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

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 218 of file Simulate.cpp.

                                                                   {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Empty WaveValue name", inName);
         throw e;
     }
     WaveValueSharedPtr waveValue;
     mWaveValueSymTab.get(inName, waveValue);
     return waveValue;
 }

Here is the call graph for this function:

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

inline

Get all the apply objects.

Parameters

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

Definition at line 224 of file Simulate.hpp.

                                                                               {
     outAllApply.insert(outAllApply.end(), mAllApply.begin(), mAllApply.end());
 }

const std::vector< std::string > & torc::generic::Commentable::getComments ( ) const

inlineinherited

Get the list of all comments

Returns: A list of all comments on this object

Definition at line 85 of file Commentable.hpp.

                                                                   {
     return mComments;
 }

const std::string torc::generic::Nameable::getName ( void ) const

inlinevirtualinherited

Get the object name

Returns: Name of the object

Definition at line 89 of file Nameable.hpp.

                                                {
     return mName;
 }

Here is the caller graph for this function:

Renamable::Name torc::generic::Renamable::getOriginalName ( ) const

inlinevirtualinherited

Get the new name provided for the object.

Returns: Name of the object

Definition at line 78 of file generic/Renamable.hpp.

                                                       {
     return mOriginalName;
 }

Here is the caller graph for this function:

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

inline

Get all the PortListAlias of this simulation.

Parameters

[out] outPortListAliases Vector of PortListAlias to be appended to

Definition at line 214 of file Simulate.hpp.

                                                                  {
     mPortListAliasSymTab.getValues(outPortListAliases);
 }

Pointer torc::generic::SelfReferencing< Simulate >::getSharedThis ( ) const

inlineinherited

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Returns: A shared pointer to this object

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Parameters

[out] ptr Set to a shared pointer to this object

void torc::generic::UserDataContainer::getUserData ( std::list< std::string > & outUserData ) const

inlineinherited

Get the list of all userData

Parameters

[out] outUserData The list of all userData

Definition at line 78 of file UserDataContainer.hpp.

                                                                                 {
     outUserData.insert(outUserData.end(), mUserData.begin(), mUserData.end());
     return;
 }

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

inline

Get the vector of wave values.

Parameters

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

Definition at line 233 of file Simulate.hpp.

                                                                                       {
     mWaveValueSymTab.getValues(outWaveValues);
 }

Here is the call graph for this function:

Simulate& torc::generic::Simulate::operator= ( const Simulate & source )

private

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 157 of file Simulate.cpp.

                                                                                     {
     std::vector<ApplySharedPtr>::const_iterator it = inAllApply.begin();
     for(; it != inAllApply.end(); it++) {
         try {
             addApply(*it);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
 }

Here is the call graph for this function:

void torc::generic::Commentable::setComments ( const std::vector< std::string > & inSource )

inherited

Get the list of all comments

Parameters

[in] inSource A list of all comments to be set on this object

Definition at line 45 of file Commentable.cpp.

                                                                   {
     mComments.insert(mComments.end(), inSource.begin(), inSource.end());
 }

void torc::generic::Nameable::setName	(	const std::string &	inSource	)
throw	(	Error
	)

inherited

Set a name for this object

Parameters

[in] inSource Name of the object

Exceptions

Error

Could not set name, because name is empty (Will be used by array members)

Id : eMessageIdErrorEmptyItemName
Context Data
- Nameable - String

Set a name for this object

Parameters

[in] inSource Name of the object

Exceptions

Error Could not set name, because name is empty (Will be used by array members)

Definition at line 41 of file Nameable.cpp.

                                                               {
     if(inSource.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Nameable", inSource);
         throw e;
     }
     mName = inSource;
 }

Here is the call graph for this function:

void torc::generic::Renamable::setOriginalName ( const Name & inSource )

virtualinherited

Set the new name provided for the object.

Parameters

[in] inSource Name of the object

Definition at line 35 of file generic/Renamable.cpp.

                                                              {
     mOriginalName = inSource;
 }

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 107 of file Simulate.cpp.

                   {
     std::vector<PortListAliasSharedPtr>::const_iterator it = inPortListAliases.begin();
     for(; it != inPortListAliases.end(); it++) {
         try {
             addPortListAlias(*it);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
 }

Here is the call graph for this function:

void torc::generic::UserDataContainer::setUserData ( const std::list< std::string > & inSource )

inherited

Set the list of userData

Parameters

[in] inSource The list of UserData

Definition at line 26 of file UserDataContainer.cpp.

                                                                       {
     mUserData.insert(mUserData.end(), inSource.begin(), inSource.end());
 }

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 174 of file Simulate.cpp.

                                                                                             {
     std::vector<WaveValueSharedPtr>::const_iterator it = inWaveValues.begin();
     for(; it != inWaveValues.end(); it++) {
         try {
             addWaveValue(*it);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
 }

Here is the call graph for this function:

void torc::generic::SelfReferencing< Simulate >::setWeakThis ( const WeakPointer & inWeakThis )

inlineinherited

Set a weak pointer to this object. This will be used later to get a shared pointer to this object from within other member methods if required. This should be called by the Factory creating the object.

Parameters

[in] weakThis A weak pointer to this object

Friends And Related Function Documentation

friend class FactoryType< Simulate >

friend

Definition at line 48 of file Simulate.hpp.

Field Documentation

std::vector<ApplySharedPtr> torc::generic::Simulate::mAllApply

private

Definition at line 205 of file Simulate.hpp.

SymTab<std::string, PortListAliasSharedPtr> torc::generic::Simulate::mPortListAliasSymTab

private

Definition at line 203 of file Simulate.hpp.

SymTab<std::string, WaveValueSharedPtr> torc::generic::Simulate::mWaveValueSymTab

private

Definition at line 204 of file Simulate.hpp.

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

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation