torc::generic::InterfaceJoinedInfo Class Reference

Represents the Interface joining information. More...

#include <InterfaceJoinedInfo.hpp>

Inheritance diagram for torc::generic::InterfaceJoinedInfo:

Collaboration diagram for torc::generic::InterfaceJoinedInfo:

Data Structures
class	Factory

Public Types
enum	JoinedType { eJoinedTypeJoin = 0, eJoinedTypeWeak, eJoinedTypeMust }
enum	RelationType { eRelationTypeParent = 0, eRelationTypeChild }
typedef VisitorType < InterfaceJoinedInfo >	Visitor
typedef InterfaceJoinedInfo	Type
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 JoinedType	getJoinedType () const
void	setJoinedType (const JoinedType &inSource)
void	addPort (const PortSharedPtr &inPort) throw (Error)
void	getPorts (std::list< PortSharedPtr > &outPorts) const
void	setPorts (const std::list< PortSharedPtr > &inSource)
void	addPortList (const PortListSharedPtr &inPortList)
void	getPortLists (std::list< PortListSharedPtr > &outPortLists) const
void	setPortLists (const std::list< PortListSharedPtr > &inSource)
void	getChildren (std::vector< InterfaceJoinedInfoSharedPtr > &outJoinedInfos) const
void	setChildren (const std::vector< InterfaceJoinedInfoSharedPtr > &inSource)
bool	addChildJoinedInfo (const InterfaceJoinedInfoSharedPtr &inChildJoinInfo)
template<typename _Action >
void	applyOnAllChildren (const _Action &action) throw (Error)
const RelationType	getRelationType () const
void	setRelationType (const RelationType &inSource)
size_t	getSize () const
virtual	~InterfaceJoinedInfo () throw ()
void	setWeakThis (const WeakPointer &inWeakThis)
Pointer	getSharedThis () const

Protected Member Functions
	InterfaceJoinedInfo ()

Private Attributes
JoinedType	mJoinedType
RelationType	mRelationType
std::list< PortSharedPtr >	mJoinedPorts
std::list< PortListSharedPtr >	mJoinedPortLists
std::vector < InterfaceJoinedInfoSharedPtr >	mChildren

Friends
class	FactoryType< InterfaceJoinedInfo >

Detailed Description

Represents the Interface joining information.

The InterfaceJoinedInfo class is used to hold interface joining information. Joining information specify which ports (scalar port, array of ports, bundle of ports) or port lists are shorted together.

Definition at line 43 of file InterfaceJoinedInfo.hpp.

Member Typedef Documentation

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

inherited

Definition at line 36 of file SelfReferencing.hpp.

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

inherited

Definition at line 35 of file SelfReferencing.hpp.

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

Convenience class to visit an interface joining information.

Definition at line 67 of file InterfaceJoinedInfo.hpp.

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

inherited

Definition at line 37 of file SelfReferencing.hpp.

Member Enumeration Documentation

enum torc::generic::InterfaceJoinedInfo::JoinedType

Interface joining type

Enumerator
eJoinedTypeJoin
eJoinedTypeWeak
eJoinedTypeMust

Definition at line 51 of file InterfaceJoinedInfo.hpp.

                    {
        eJoinedTypeJoin = 0, eJoinedTypeWeak, eJoinedTypeMust
    };

enum torc::generic::InterfaceJoinedInfo::RelationType

Type of the InterfaceJoinedInfo, Is it parent or child.

Enumerator
eRelationTypeParent
eRelationTypeChild

Definition at line 60 of file InterfaceJoinedInfo.hpp.

                      {
        eRelationTypeParent = 0, eRelationTypeChild
    };

Constructor & Destructor Documentation

torc::generic::InterfaceJoinedInfo::~InterfaceJoinedInfo ( ) throw ( )

virtual

Definition at line 249 of file InterfaceJoinedInfo.cpp.

{}

torc::generic::InterfaceJoinedInfo::InterfaceJoinedInfo ( )

protected

Definition at line 246 of file InterfaceJoinedInfo.cpp.

                                         : Visitable(), SelfReferencing<InterfaceJoinedInfo>(),
    mJoinedType(), mRelationType(), mJoinedPorts(), mJoinedPortLists(), mChildren() {}

Member Function Documentation

void torc::generic::InterfaceJoinedInfo::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.

Implements torc::generic::Visitable.

Definition at line 167 of file InterfaceJoinedInfo.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::InterfaceJoinedInfo::addChildJoinedInfo

(

const InterfaceJoinedInfoSharedPtr &

inChildJoinInfo

)

Add a joined info to parent joined info

Parameters

[in]

inChildJoinInfo

Child interface joined info to be added to parent

Definition at line 153 of file InterfaceJoinedInfo.cpp.

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

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::InterfaceJoinedInfo::addPort	(	const PortSharedPtr &	inPort	)
throw	(	Error
	)

Add a port to the list of ports. Empty pointer is ignored.

Parameters

[in]

inPort

Pointer to port to be added.

Exceptions

Error

Could not add port, because Port name is empty

Definition at line 67 of file InterfaceJoinedInfo.cpp.

                                                                           {
    if(!inPort) {
        return;
    }
    std::string name = inPort->getName();
    if(name.empty()) {
        Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Port name", name);
        throw e;
    }
    mJoinedPorts.push_back(inPort);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::InterfaceJoinedInfo::addPortList

(

const PortListSharedPtr &

inPortList

)

Add a portList to the list of portLists. Empty pointer is ignored.

Parameters

[in]

inPortList

Pointer to portList to be added.

Definition at line 85 of file InterfaceJoinedInfo.cpp.

                                                                         {
    if(!inPortList) {
        return;
    }
    mJoinedPortLists.push_back(inPortList);
}

Here is the caller graph for this function:

template<typename _Action >

void torc::generic::InterfaceJoinedInfo::applyOnAllChildren ( const _Action &  action ) throw ( Error )

inline

Apply action on all children

Parameters

[in]

action

Action to be applied

Definition at line 268 of file InterfaceJoinedInfo.hpp.

                                         {
    try {
        std::vector<InterfaceJoinedInfoSharedPtr>::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:

void torc::generic::InterfaceJoinedInfo::getChildren ( std::vector< InterfaceJoinedInfoSharedPtr > &  outJoinedInfos ) const

inline

Get the nested interface joined info.

Parameters

[out]

outJoinedInfos

Vector of interface joined info to be appended to

Definition at line 259 of file InterfaceJoinedInfo.hpp.

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

Here is the caller graph for this function:

const InterfaceJoinedInfo::JoinedType torc::generic::InterfaceJoinedInfo::getJoinedType ( ) const

inline

Get the interface joining type

Returns

Interface joining type

Definition at line 232 of file InterfaceJoinedInfo.hpp.

                                                                                    {
    return mJoinedType;
}

void torc::generic::InterfaceJoinedInfo::getPortLists ( std::list< PortListSharedPtr > &  outPortLists ) const

inline

Get the list of joined portLists of an interface

Returns

outPortLists List of joined portLists to be appended to

Get the list of joined portLists of an interface

Returns

outPorts List of joined portLists to be appended to

Definition at line 250 of file InterfaceJoinedInfo.hpp.

                                                                                            {
    outPortLists.insert(outPortLists.end(), mJoinedPortLists.begin(), mJoinedPortLists.end());
}

Here is the caller graph for this function:

void torc::generic::InterfaceJoinedInfo::getPorts ( std::list< PortSharedPtr > &  outPorts ) const

inline

Get the list of pointers to the joined ports of an interface

Returns

outPorts List of ports to be appended to

Definition at line 241 of file InterfaceJoinedInfo.hpp.

                                                                                {
    outPorts.insert(outPorts.end(), mJoinedPorts.begin(), mJoinedPorts.end());
}

Here is the caller graph for this function:

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

inline

Get the relation type.

Returns

RelationType

Definition at line 286 of file InterfaceJoinedInfo.hpp.

                                                                                        {
    return mRelationType;
}

Here is the caller graph for this function:

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

(

void

)

const

Get the total number of bits of the composition

Returns

Number of bits

Definition at line 189 of file InterfaceJoinedInfo.cpp.

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

    std::vector<InterfaceJoinedInfoSharedPtr> outJoinedInfos;
    getChildren(outJoinedInfos);
    std::vector<InterfaceJoinedInfoSharedPtr>::iterator joinedInfoIt = outJoinedInfos.begin();

    std::list<PortSharedPtr> outPorts;
    getPorts(outPorts);
    std::list<PortSharedPtr>::iterator portIt = outPorts.begin();

    std::list<PortListSharedPtr> outPortLists;
    getPortLists(outPortLists);
    std::list<PortListSharedPtr>::iterator portListIt = outPortLists.begin();

    if(InterfaceJoinedInfo::eRelationTypeParent == rType) {
        if(!outPorts.empty()) {
            pSize = (*portIt)->getSize();
        } else if(!outPortLists.empty()) {
            pSize = (*portListIt)->getSize();
        } else if(!outJoinedInfos.empty()) {
            for(; joinedInfoIt != outJoinedInfos.end(); joinedInfoIt++) {
                pSize += (*joinedInfoIt)->getSize();
                for(; portIt != outPorts.end(); portIt++) {
                    pSize += (*portIt)->getSize();
                }
                for(; portListIt != outPortLists.end(); portListIt++) {
                    pSize += (*portListIt)->getSize();
                }
            }
        } else {
            pSize = 0;
        }
    } else {
        if(!outPorts.empty()) {
            for(; portIt != outPorts.end(); portIt++) {
                cSize += (*portIt)->getSize();
            }
        }
        if(!outPortLists.empty()) {
            for(; portListIt != outPortLists.end(); portListIt++) {
                cSize += (*portListIt)->getSize();
            }
        }
        if(!outJoinedInfos.empty()) {
            for(; joinedInfoIt != outJoinedInfos.end(); joinedInfoIt++) {
                cSize += (*joinedInfoIt)->getSize();
            }
        }
    }
    size = pSize + cSize;
    return size;
}

Here is the call graph for this function:

void torc::generic::InterfaceJoinedInfo::setChildren

(

const std::vector< InterfaceJoinedInfoSharedPtr > &

inSource

)

Set the nested joining information

Parameters

[in]

inSource

Vector containing joining informations

Exceptions

Error

Could not add child joined info because pointer to the joined info does not exist

Definition at line 135 of file InterfaceJoinedInfo.cpp.

                                                                                             {
    std::vector<InterfaceJoinedInfoSharedPtr>::const_iterator entry = inSource.begin();
    std::vector<InterfaceJoinedInfoSharedPtr>::const_iterator end = inSource.end();
    for(; entry != end; ++entry) {
        try {
            addChildJoinedInfo(*entry);
        } catch(Error& e) {
            e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
            throw;
        }
    }
}

Here is the call graph for this function:

void torc::generic::InterfaceJoinedInfo::setJoinedType

(

const JoinedType &

value

)

Set the interface joining type

Parameters

[in]

inSource

Interface joining type

Definition at line 57 of file InterfaceJoinedInfo.cpp.

                                                               {
    mJoinedType = value;
}

void torc::generic::InterfaceJoinedInfo::setPortLists

(

const std::list< PortListSharedPtr > &

inSource

)

Set the list of joined portLists of an interface

Parameters

[in]

inSource

List of portLists to be joined to an interface

Definition at line 115 of file InterfaceJoinedInfo.cpp.

                                                                                 {
    std::list<PortListSharedPtr>::const_iterator portList = inSource.begin();
    std::list<PortListSharedPtr>::const_iterator end = inSource.end();
    for(; portList != end; ++portList) {
        try {
            addPortList(*portList);
        } catch(Error& e) {
            e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
            throw;
        }
    }
}

Here is the call graph for this function:

void torc::generic::InterfaceJoinedInfo::setPorts

(

const std::list< PortSharedPtr > &

inSource

)

Set the list of joined ports of an interface

Parameters

[in]

inSource

List of ports to be joined to an interface

Definition at line 97 of file InterfaceJoinedInfo.cpp.

                                                                         {
    std::list<PortSharedPtr>::const_iterator port = inSource.begin();
    std::list<PortSharedPtr>::const_iterator end = inSource.end();
    for(; port != end; ++port) {
        try {
            addPort(*port);
        } catch(Error& e) {
            e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
            throw;
        }
    }
}

Here is the call graph for this function:

void torc::generic::InterfaceJoinedInfo::setRelationType

(

const RelationType &

inSource

)

Set the relation type.

Parameters

[in]

inSource

RelationType

Definition at line 181 of file InterfaceJoinedInfo.cpp.

                                                                      {
    mRelationType = inSource;
}

void torc::generic::SelfReferencing< InterfaceJoinedInfo >::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< InterfaceJoinedInfo >

friend

Definition at line 44 of file InterfaceJoinedInfo.hpp.

Field Documentation

std::vector<InterfaceJoinedInfoSharedPtr> torc::generic::InterfaceJoinedInfo::mChildren

private

Definition at line 223 of file InterfaceJoinedInfo.hpp.

std::list<PortListSharedPtr> torc::generic::InterfaceJoinedInfo::mJoinedPortLists

private

Definition at line 222 of file InterfaceJoinedInfo.hpp.

std::list<PortSharedPtr> torc::generic::InterfaceJoinedInfo::mJoinedPorts

private

Definition at line 221 of file InterfaceJoinedInfo.hpp.

JoinedType torc::generic::InterfaceJoinedInfo::mJoinedType

private

Definition at line 219 of file InterfaceJoinedInfo.hpp.

RelationType torc::generic::InterfaceJoinedInfo::mRelationType

private

Definition at line 220 of file InterfaceJoinedInfo.hpp.

---

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

• InterfaceJoinedInfo.hpp
• InterfaceJoinedInfo.cpp