torc::generic::SimulationInfo Class Reference

This class is used to hold all information about the logic values used within a library. More...

#include <SimulationInfo.hpp>

Inheritance diagram for torc::generic::SimulationInfo:

Collaboration diagram for torc::generic::SimulationInfo:

Data Structures
class	Factory

Public Types
typedef VisitorType < SimulationInfo >	Visitor
typedef SimulationInfo	Type
typedef boost::shared_ptr< Type >	Pointer
typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)
void	addLogicValue (const LogicValueSharedPtr &inLogicValue) throw (Error)
LogicValueSharedPtr	findLogicValue (const std::string &inName)
void	removeLogicValue (const std::string &inName) throw (Error)
void	getLogicValues (std::vector< LogicValueSharedPtr > &outLogicValues) const
void	setLogicValues (const std::vector< LogicValueSharedPtr > &inLogicValues) throw (Error)
template<typename _Action >
void	applyOnAllLogicValues (const _Action &action) throw (Error)
virtual	~SimulationInfo () throw ()
void	addComment (const std::string &comment)
const std::vector< std::string > &	getComments () const
void	setComments (const std::vector< std::string > &inSource)
const boost::shared_ptr< Library >	getParent () const
virtual void	setParent (const boost::shared_ptr< Library > &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
	SimulationInfo ()

Private Member Functions
	SimulationInfo (const SimulationInfo &source)
SimulationInfo &	operator= (const SimulationInfo &source)

Private Attributes
SymTab< std::string, LogicValueSharedPtr >	mLogicValueSymTab

Friends
class	FactoryType< SimulationInfo >

Detailed Description

This class is used to hold all information about the logic values used within a library.

Definition at line 44 of file SimulationInfo.hpp.

Member Typedef Documentation

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

inherited

Definition at line 36 of file SelfReferencing.hpp.

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

inherited

Definition at line 35 of file SelfReferencing.hpp.

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

Convenience typedef for visiting a simulation info

Definition at line 53 of file SimulationInfo.hpp.

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

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::SimulationInfo::~SimulationInfo ( ) throw ( )

virtual

Definition at line 142 of file SimulationInfo.cpp.

{}

torc::generic::SimulationInfo::SimulationInfo ( )

protected

Definition at line 139 of file SimulationInfo.cpp.

                               : Commentable(), Visitable(), ParentedObject<Library>(),
    SelfReferencing<SimulationInfo>(), UserDataContainer(), mLogicValueSymTab() {}

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

private

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 46 of file SimulationInfo.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::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::SimulationInfo::addLogicValue	(	const LogicValueSharedPtr &	inLogicValue	)
throw	(	Error
	)

Add a logic value to the list of logic values. If an empty pointer is supplied, it returns without doing anything.

Parameters

[in]

inLogicValue

A pointer to a logic value object.

Exceptions

Error

Logic value could not be added.

Definition at line 81 of file SimulationInfo.cpp.

                                                                                        {
    if(!inLogicValue) {
        return;
    }
    std::string name = inLogicValue->getName();
    if(name.empty()) {
        Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Empty logic value name ", name);
        throw e;
    }
    if(false == mLogicValueSymTab.set(name, inLogicValue)) {
        Error e(eMessageIdErrorItemAlreadyExists, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Logic value name", name);
        throw e;
    }
    inLogicValue->setParent(getSharedThis());
}

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);
}

template<typename _Action >

void torc::generic::SimulationInfo::applyOnAllLogicValues ( const _Action &  action ) throw ( Error )

inline

Apply action on all logic values.

Parameters

[in]

action

Action to be applied

Definition at line 156 of file SimulationInfo.hpp.

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

Here is the call graph for this function:

LogicValueSharedPtr torc::generic::SimulationInfo::findLogicValue

(

const std::string &

inName

)

Find a logic value by name, in the list of logic values in simulationInfo.

Parameters

[in]

inName

String value specifying the name of the logic value.

Returns

A pointer to the logic value if found, an empty pointer otherwise.

Find a logic value by name, in the list of logic values in simulationInfo.

Parameters

[in]

name

String value specifying the name of the logic value.

Returns

A pointer to the logic value if found, an empty pointer otherwise.

Definition at line 106 of file SimulationInfo.cpp.

                                                                          {
    if(inName.empty()) {
        Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Empty logic value name", inName);
        throw e;
    }
    LogicValueSharedPtr logicValue;
    mLogicValueSymTab.get(inName, logicValue);
    return logicValue;
}

Here is the call graph for this function:

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;
}

void torc::generic::SimulationInfo::getLogicValues ( std::vector< LogicValueSharedPtr > &  outLogicValues ) const

inline

Get the list of logic values.

Parameters

[out]

outLogicValues

Vector of logic values to be appended to

Definition at line 147 of file SimulationInfo.hpp.

                                                                                               {
    mLogicValueSymTab.getValues(outLogicValues);
}

const boost::shared_ptr<Library > torc::generic::ParentedObject< Library >::getParent ( ) const

inlineinherited

Get a pointer to the parent object

Returns

Pointer to parent

Pointer torc::generic::SelfReferencing< SimulationInfo >::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;
}

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

private

void torc::generic::SimulationInfo::removeLogicValue	(	const std::string &	inName	)
throw	(	Error
	)

Remove the specified logic value from the list of logic values. If an empty pointer is passed, it returns without doing anything

Parameters

[in]

inName

name of the object to be removed

Exceptions

Error

Logic Value not preset in collection.

Definition at line 125 of file SimulationInfo.cpp.

                                                                           {
    if(inName.empty()) {
        Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Logic value name", inName);
        throw e;
    }
    if(false == mLogicValueSymTab.remove(inName)) {
        Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Logic value name", inName);
        throw e;
    }
    return;
}

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::SimulationInfo::setLogicValues	(	const std::vector< LogicValueSharedPtr > &	inLogicValues	)
throw	(	Error
	)

Set the list of logic values.

Parameters

[in]

inLogicValues

Vector of logic values to be appended to

Definition at line 60 of file SimulationInfo.cpp.

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

Here is the call graph for this function:

virtual void torc::generic::ParentedObject< Library >::setParent ( const boost::shared_ptr< Library > &  inSource )

virtualinherited

Set a pointer to the parent

Parameters

[in]

inSource

Set a pointer to the parent

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::SelfReferencing< SimulationInfo >::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< SimulationInfo >

friend

Definition at line 47 of file SimulationInfo.hpp.

Field Documentation

SymTab<std::string, LogicValueSharedPtr> torc::generic::SimulationInfo::mLogicValueSymTab

private

Definition at line 138 of file SimulationInfo.hpp.

---

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

• SimulationInfo.hpp
• SimulationInfo.cpp