torc::generic::LogicElement Class Reference

Represents different logic elements which holds array of logic values. More...

#include <LogicElement.hpp>

Inheritance diagram for torc::generic::LogicElement:

Collaboration diagram for torc::generic::LogicElement:

Data Structures
class	Factory

Public Types
enum	Type {   eTypeSingle = 0, eTypeList, eTypeOneOf, eTypeWaveForm,   eTypeIgnored, eTypeTransition, eTypeBecomes }
enum	RelationType { eRelationTypeParent = 0, eRelationTypeChild }
typedef VisitorType< LogicElement >	Visitor
typedef std::string	Name
typedef boost::shared_ptr< Type >	Pointer
typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual void	accept (BaseVisitor &visitor) throw (Error)
	Receive a visitor to this class. The visit method of the visitor 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 situation can arise when the passed Visitor object does not inherit from the appropriate visitor specialization. See Visitor documentation for more details. More...
const Type	getType () const
void	setType (const Type &inSource)
void	getChildren (std::vector< LogicElementSharedPtr > &outLogicElements) const
void	setChildren (const std::vector< LogicElementSharedPtr > &inSource)
bool	addChildLogicElement (const LogicElementSharedPtr &inChildLogicElement)
template<typename _Action >
void	applyOnAllChildren (const _Action &action) throw (Error)
const RelationType	getRelationType () const
void	setRelationType (const RelationType &inSource)
size_t	getSize () const
	~LogicElement () throw ()
const LogicValueAttributesSharedPtr	getAttributes () const
void	setAttributes (const LogicValueAttributesSharedPtr &inSource)
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)
const boost::shared_ptr < SimulationInfo >	getParent () const
virtual void	setParent (const boost::shared_ptr< SimulationInfo > &inSource)
PropertySharedPtr	getProperty (const std::string &inName)
bool	setProperty (const std::string &inName, const PropertySharedPtr &inProperty)
void	getProperties (std::map< std::string, PropertySharedPtr > &outProperties) const
void	setProperties (const std::map< std::string, PropertySharedPtr > &inSource)
template<typename _Action >
void	applyOnAllProperties (const _Action &action) throw (Error)
void	getUserData (std::list< std::string > &outUserData) const
void	setUserData (const std::list< std::string > &inSource)
void	addUserData (const std::string &inSource)
void	setWeakThis (const WeakPointer &inWeakThis)
Pointer	getSharedThis () const

Protected Member Functions
	LogicElement ()

Private Attributes
Type	mType
RelationType	mRelationType
std::vector < LogicElementSharedPtr >	mChildren

Friends
class	FactoryType< LogicElement >

Detailed Description

Represents different logic elements which holds array of logic values.

The LogicElement class is used to represent different logic elements constructs in EDIF like logicWaveForm, logicOneOf, logicList, transition, becomes, ignore and logic value name.

Definition at line 41 of file LogicElement.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< LogicValue >::Pointer

inherited

Definition at line 36 of file SelfReferencing.hpp.

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

Convenience class to visit a logic element.

Definition at line 67 of file LogicElement.hpp.

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

inherited

Definition at line 37 of file SelfReferencing.hpp.

Member Enumeration Documentation

enum torc::generic::LogicElement::RelationType

Relation type of the logic elements, is it parent or child.

Enumerator
eRelationTypeParent
eRelationTypeChild

Definition at line 60 of file LogicElement.hpp.

                      {
        eRelationTypeParent = 0, eRelationTypeChild
    };

enum torc::generic::LogicElement::Type

Logic element type

Enumerator
eTypeSingle
eTypeList
eTypeOneOf
eTypeWaveForm
eTypeIgnored
eTypeTransition
eTypeBecomes

Definition at line 50 of file LogicElement.hpp.

              {
        eTypeSingle = 0, eTypeList, eTypeOneOf, eTypeWaveForm, eTypeIgnored, eTypeTransition,
        eTypeBecomes
    };

Constructor & Destructor Documentation

torc::generic::LogicElement::~LogicElement	(		)
throw	(
	)

Definition at line 171 of file LogicElement.cpp.

{}

torc::generic::LogicElement::LogicElement ( )

protected

Definition at line 169 of file LogicElement.cpp.

: LogicValue(), mType(), mRelationType(), mChildren() {}

Member Function Documentation

void torc::generic::LogicElement::accept ( BaseVisitor &  visitor ) throw ( Error )

virtual

Receive a visitor to this class. The visit method of the visitor 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 situation can arise when the passed Visitor object does not inherit from the appropriate visitor specialization. See Visitor documentation for more details.

Parameters

[in,out]

visitor

A reference to the visitor object

Exceptions

Error

Visitor type inappropriate for visiting this object or any other error thrown by the Visitor::throw() method.

Reimplemented from torc::generic::LogicValue.

Definition at line 98 of file LogicElement.cpp.

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

Here is the call graph for this function:

bool torc::generic::LogicElement::addChildLogicElement

(

const LogicElementSharedPtr &

inChildLogicElement

)

Add a logic element to parent logic element

Parameters

[in]

inChildLogicElement

Child logic element to be added to parent

Definition at line 86 of file LogicElement.cpp.

                                                                                        {
    if(!inChildLogicElement) {
        Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Pointer to the logic element object does not exist",
            inChildLogicElement);
        throw e;
    } else {
        mChildren.push_back(inChildLogicElement);
        return true;
    }
}

Here is the call graph for this function:

Here is the caller 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::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::LogicElement::applyOnAllChildren ( const _Action &  action ) throw ( Error )

inline

Apply action on all children

Parameters

[in]

action

Action to be applied

Definition at line 204 of file LogicElement.hpp.

                  {
    try {
        std::vector<LogicElementSharedPtr>::iterator it = mChildren.begin();
        for(; it != mChildren.end(); ++it) {
            action(*it);
        }
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

template<typename _Action >

void torc::generic::PropertyContainer::applyOnAllProperties ( const _Action &  action ) throw ( Error )

inlineinherited

Apply action on all properties.

Parameters

[in]

action

Action to be applied

Definition at line 113 of file PropertyContainer.hpp.

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

Here is the call graph for this function:

const LogicValueAttributesSharedPtr torc::generic::LogicValue::getAttributes ( ) const

inlineinherited

Get the attributes of the LogicValue. Attributes include voltageMap, currentMap, booleanMap, compound, weak, strong, dominates etc.

Returns

Pointer to LogicValueAttributes object.

Definition at line 125 of file LogicValue.hpp.

                                                                           {
    return mAttributes;
}

void torc::generic::LogicElement::getChildren ( std::vector< LogicElementSharedPtr > &  outLogicElements ) const

inline

Get the nested logic elements.

Parameters

[out]

outLogicElements

Vector of logic element to be appended to

Definition at line 196 of file LogicElement.hpp.

                                                                                               {
    outLogicElements.insert(outLogicElements.end(), mChildren.begin(), mChildren.end());
}

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

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:

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

inlineinherited

Get a pointer to the parent object

Returns

Pointer to parent

void torc::generic::PropertyContainer::getProperties ( std::map< std::string, PropertySharedPtr > &  outProperties ) const

inlineinherited

Get the map of all properties

Parameters

[out]

outProperties

The map of properties

Get the map of all properties

Returns

The map of properties

Definition at line 107 of file PropertyContainer.hpp.

                                                               {
    mProperties.getValueMap(outProperties);
    return;
}

Here is the call graph for this function:

PropertySharedPtr torc::generic::PropertyContainer::getProperty ( const std::string &  inName )

inherited

Get a property

Parameters

[in]

inName

Name of the property to be retreived

Returns

Pointer to the property object if present, empty pointer otherwise.

Get a property

Parameters

[in]

name

Name of the property to be retreived

Returns

Pointer to the property object if present, empty pointer otherwise.

Definition at line 37 of file PropertyContainer.cpp.

                                                                        {
    PropertySharedPtr property;
    if(!inName.empty()) {
        mProperties.get(inName, property);
    }
    return property;
}

Here is the call graph for this function:

Here is the caller graph for this function:

const LogicElement::RelationType torc::generic::LogicElement::getRelationType ( ) const

inline

Get the relation type.

Returns

RelationType

Definition at line 222 of file LogicElement.hpp.

                                                                          {
    return mRelationType;
}

Here is the caller graph for this function:

Pointer torc::generic::SelfReferencing< LogicValue >::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

size_t torc::generic::LogicElement::getSize

(

void

)

const

Get the total number of bits of the composition

Returns

Number of bits

Definition at line 120 of file LogicElement.cpp.

                                   {
    size_t size = 0;
    size_t pSize = 0;
    size_t cSize = 0;
    LogicElement::RelationType rType = getRelationType();

    std::vector<LogicElementSharedPtr> outLogicElements;
    getChildren(outLogicElements);

    std::vector<LogicElementSharedPtr>::iterator logicElemIt = outLogicElements.begin();
    if(LogicElement::eTypeSingle == getType() || LogicElement::eTypeIgnored == getType()) {
        return 1;
    }

    if(LogicElement::eTypeOneOf == getType()) {
        if(!outLogicElements.empty()) {
            size += (*logicElemIt)->getSize();
        } else {
            size = 0;
        }
        return size;
    }

    if(LogicElement::eTypeWaveForm == getType()) {
        if(!outLogicElements.empty()) {
            size += (*logicElemIt)->getSize();
        } else {
            size = 0;
        }
        return size;
    }

    if(LogicElement::eRelationTypeParent == rType) {
        if(!outLogicElements.empty()) {
            pSize += (*logicElemIt)->getSize();
        } else {
            pSize = 0;
        }
    } else {
        if(!outLogicElements.empty()) {
            for(; logicElemIt != outLogicElements.end(); logicElemIt++) {
                cSize += (*logicElemIt)->getSize();
            }
        }
    }
    size = pSize + cSize;
    return size;
}

Here is the call graph for this function:

const LogicElement::Type torc::generic::LogicElement::getType ( void  ) const

inline

Get the Logic element type

Returns

Logic element type

Definition at line 187 of file LogicElement.hpp.

                                                          {
    return mType;
}

Here is the caller graph for this function:

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::LogicValue::setAttributes ( const LogicValueAttributesSharedPtr &  inSource )

inherited

Set the attributes of the LogicValue. Attributes include voltageMap, currentMap, booleanMap, compound, weak, strong, dominates etc.

Parameters

[in]

inSource

Pointer to LogicValueAttributes object.

Definition at line 59 of file LogicValue.cpp.

                                                                            {
    mAttributes = inSource;
}

void torc::generic::LogicElement::setChildren

(

const std::vector< LogicElementSharedPtr > &

inSource

)

Set the nested logic elements.

Parameters

[in]

inSource

Vector containing logic elements.

Exceptions

Error

Could not add child logic elements because pointer to the logic elements does not exist

Definition at line 68 of file LogicElement.cpp.

                                                                               {
    std::vector<LogicElementSharedPtr>::const_iterator entry = inSource.begin();
    std::vector<LogicElementSharedPtr>::const_iterator end = inSource.end();
    for(; entry != end; ++entry) {
        try {
            addChildLogicElement(*entry);
        } 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;
}

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

virtualinherited

Set a pointer to the parent

Parameters

[in]

inSource

Set a pointer to the parent

void torc::generic::PropertyContainer::setProperties ( const std::map< std::string, PropertySharedPtr > &  inSource )

inherited

Set the map of properties

Parameters

[in]

inSource

The map of properties

Definition at line 66 of file PropertyContainer.cpp.

                                                                                          {
    std::map<std::string, PropertySharedPtr>::const_iterator it = inSource.begin();
    for(; it != inSource.end(); it++) {
        setProperty((*it).first, (*it).second);
    }
}

Here is the call graph for this function:

bool torc::generic::PropertyContainer::setProperty ( const std::string &  inName, const PropertySharedPtr &  inProperty  )

inherited

Save the inSource of a property

Parameters

[in]	inName	Name of the property to be saved
[in]	inProperty	Pointer to the property object if present, empty pointer otherwise.

Returns

bool True if saved, false otherwise.

Save the inSource of a property

Parameters

[in]	inName	Name of the property to be saved
[in]	inPoperty	Pointer to the property object if present, empty pointer otherwise.

Returns

bool True if saved, false otherwise.

Definition at line 53 of file PropertyContainer.cpp.

                                         {
    if(!inName.empty()) {
        return mProperties.set(inName, inProperty);
    }
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::LogicElement::setRelationType

(

const RelationType &

inSource

)

Set the relation type.

Parameters

[in]

inSource

RelationType

Definition at line 112 of file LogicElement.cpp.

                                                               {
    mRelationType = inSource;
}

void torc::generic::LogicElement::setType

(

const Type &

inSource

)

Set the Logic element type

Parameters

[in]

inSource

Logic element type

Definition at line 57 of file LogicElement.cpp.

                                               {
    mType = inSource;
}

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< LogicValue >::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< LogicElement >

friend

Definition at line 43 of file LogicElement.hpp.

Field Documentation

std::vector<LogicElementSharedPtr> torc::generic::LogicElement::mChildren

private

Definition at line 178 of file LogicElement.hpp.

RelationType torc::generic::LogicElement::mRelationType

private

Definition at line 177 of file LogicElement.hpp.

Type torc::generic::LogicElement::mType

private

Definition at line 176 of file LogicElement.hpp.

---

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

• LogicElement.hpp
• LogicElement.cpp