torc::generic::Timing Class Reference

This class is used to provide a set of path delays or timing constrains (forbidden events) More...

#include <Timing.hpp>

Inheritance diagram for torc::generic::Timing:

Collaboration diagram for torc::generic::Timing:

Data Structures
class	Factory

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

Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)
const Derivation	getDerivation () const
void	setDerivation (const Derivation &value)
void	getPathDelays (std::list< PathDelaySharedPtr > &outPathDelays) const
void	setPathDelays (const std::list< PathDelaySharedPtr > &inPathDelays)
void	addPathDelay (const PathDelaySharedPtr &inSource)
void	getForbiddentEvents (std::list< ForbiddenEventSharedPtr > &outForbiddentEvents) const
void	setForbiddentEvents (const std::list< ForbiddenEventSharedPtr > &inForbiddentEvents)
void	addForbiddenEvent (const ForbiddenEventSharedPtr &inSource)
	~Timing () throw ()
void	setWeakThis (const WeakPointer &inWeakThis)
Pointer	getSharedThis () const
void	addComment (const std::string &comment)
const std::vector< std::string > &	getComments () const
void	setComments (const std::vector< std::string > &inSource)
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
	Timing ()

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

Private Attributes
Derivation	mDerivation
std::list< PathDelaySharedPtr >	mPathDelays
std::list < ForbiddenEventSharedPtr >	mForbiddentEvents

Friends
class	FactoryType< Timing >

Detailed Description

This class is used to provide a set of path delays or timing constrains (forbidden events)

Definition at line 40 of file Timing.hpp.

Member Typedef Documentation

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

inherited

Definition at line 36 of file SelfReferencing.hpp.

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

inherited

Definition at line 35 of file SelfReferencing.hpp.

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

Convenience class to visit a Timing.

Definition at line 48 of file Timing.hpp.

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

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::Timing::~Timing	(		)
throw	(
	)

Definition at line 150 of file Timing.cpp.

{}

torc::generic::Timing::Timing ( )

protected

Definition at line 147 of file Timing.cpp.

               : Visitable(), SelfReferencing<Timing>(), Commentable(), UserDataContainer(),
    mDerivation(), mPathDelays(), mForbiddentEvents() {}

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

private

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 67 of file Timing.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::Timing::addForbiddenEvent

(

const ForbiddenEventSharedPtr &

inSource

)

Add a forbidden event of the list of forbidden events.

Parameters

[in]

inSource

Pointer to forbidden event to be appended to

Definition at line 138 of file Timing.cpp.

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

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::Timing::addPathDelay

(

const PathDelaySharedPtr &

inSource

)

Add a path delay to the list of path delays.

Parameters

[in]

inSource

Pointer to path delay to be appended to

Definition at line 124 of file Timing.cpp.

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

Here is the call graph for this function:

Here is the caller 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);
}

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 Derivation torc::generic::Timing::getDerivation ( ) const

inline

Get derivation

Returns

Derivation value

Definition at line 158 of file Timing.hpp.

                                                    {
    return mDerivation;
}

void torc::generic::Timing::getForbiddentEvents ( std::list< ForbiddenEventSharedPtr > &  outForbiddentEvents ) const

inline

Get all the forbidden events of this timing.

Parameters

[out]

outForbiddentEvents

List of events to be appended to

Definition at line 176 of file Timing.hpp.

          {
    outForbiddentEvents.insert(outForbiddentEvents.end(), mForbiddentEvents.begin(),
        mForbiddentEvents.end());
}

void torc::generic::Timing::getPathDelays ( std::list< PathDelaySharedPtr > &  outPathDelays ) const

inline

Get all the path delays of this timing.

Parameters

[out]

outPathDelays

List of path delays of this timing to be appended to

Definition at line 167 of file Timing.hpp.

                                                                                  {
    outPathDelays.insert(outPathDelays.end(), mPathDelays.begin(), mPathDelays.end());
}

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

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

private

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::Timing::setDerivation

(

const Derivation &

value

)

Set derivation

Parameters

[in]

value

Derivation value

Definition at line 81 of file Timing.cpp.

                                                  {
    mDerivation = value;
}

void torc::generic::Timing::setForbiddentEvents

(

const std::list< ForbiddenEventSharedPtr > &

inForbiddentEvents

)

Set all the forbidden events of this timing.

Parameters

[in]

inForbiddentEvents

List of events to be appended to

Definition at line 107 of file Timing.cpp.

                                                                                           {
    std::list<ForbiddenEventSharedPtr>::const_iterator it = inForbiddentEvents.begin();
    for(; it != inForbiddentEvents.end(); it++) {
        try {
            addForbiddenEvent(*it);
        } catch(Error& e) {
            e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
            throw;
        }
    }
}

Here is the call graph for this function:

void torc::generic::Timing::setPathDelays

(

const std::list< PathDelaySharedPtr > &

inPathDelays

)

Set all the path delays of this timing.

Parameters

[in]

inPathDelays

List of path delays of this timing to be appended to

Definition at line 90 of file Timing.cpp.

                                                                          {
    std::list<PathDelaySharedPtr>::const_iterator it = inPathDelays.begin();
    for(; it != inPathDelays.end(); it++) {
        try {
            addPathDelay(*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::SelfReferencing< Timing >::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< Timing >

friend

Definition at line 42 of file Timing.hpp.

Field Documentation

Derivation torc::generic::Timing::mDerivation

private

Definition at line 147 of file Timing.hpp.

std::list<ForbiddenEventSharedPtr> torc::generic::Timing::mForbiddentEvents

private

Definition at line 149 of file Timing.hpp.

std::list<PathDelaySharedPtr> torc::generic::Timing::mPathDelays

private

Definition at line 148 of file Timing.hpp.

---

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

• Timing.hpp
• Timing.cpp