Represents a "bundle" in the EDIF sense. More...

#include <Bundle.hpp>

Inheritance diagram for torc::generic::Bundle< _Type >:

Collaboration diagram for torc::generic::Bundle< _Type >:

Public Types
typedef Composite< _Type >	BaseType

typedef BaseType::Type	Type

typedef BaseType::Pointer	Pointer

typedef BaseType::List	List

typedef BaseType::SizeType	SizeType

typedef Type	ChildType

typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual	~Bundle () throw ()

virtual CompositionType	getCompositionType () const

virtual SizeType	getSize () const

virtual void	addChild (const boost::shared_ptr< Type > &child) throw (Error)

virtual void	getChildren (List &outChildren) const throw (Error)

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

virtual const Pointer	get (const std::vector< SizeType > &indices) const throw (Error)

virtual void	setParentCollection (const Pointer &inParentCollection)

virtual Pointer	getParentCollection () const

void	setWeakThis (const WeakPointer &inWeakThis)

Pointer	getSharedThis () const

Protected Member Functions
	Bundle ()

Private Attributes
List	mChildren

Detailed Description

template<typename _Type>
class torc::generic::Bundle< _Type >

Represents a "bundle" in the EDIF sense.

A bundle in EDIF is an ordered collection of items. For example a bundle of ports is a collection of other scalar and vector ports. The Bundle class represents an implementation of functionality for such a collection.

Definition at line 43 of file Bundle.hpp.

Member Typedef Documentation

template<typename _Type>

typedef Composite<_Type> torc::generic::Bundle< _Type >::BaseType

Definition at line 48 of file Bundle.hpp.

template<typename _Type>

typedef Type torc::generic::Bundle< _Type >::ChildType

Definition at line 53 of file Bundle.hpp.

template<typename _Type>

typedef BaseType::List torc::generic::Bundle< _Type >::List

Definition at line 51 of file Bundle.hpp.

template<typename _Type>

typedef BaseType::Pointer torc::generic::Bundle< _Type >::Pointer

Definition at line 50 of file Bundle.hpp.

template<typename _Type>

typedef BaseType::SizeType torc::generic::Bundle< _Type >::SizeType

Definition at line 52 of file Bundle.hpp.

template<typename _Type>

typedef BaseType::Type torc::generic::Bundle< _Type >::Type

Definition at line 49 of file Bundle.hpp.

template<typename _Type>

typedef boost::weak_ptr<Type> torc::generic::Composite< _Type >::WeakPointer

inherited

Definition at line 56 of file Composite.hpp.

Constructor & Destructor Documentation

template<typename _Type >

torc::generic::Bundle< _Type >::Bundle ( )

protected

Definition at line 112 of file Bundle.hpp.

112 : Composite<_Type>() {}

template<typename _Type >

torc::generic::Bundle< _Type >::~Bundle	(	)
throw	(
	)

virtual

Definition at line 114 of file Bundle.hpp.

114 {}

Member Function Documentation

template<typename _Type >

void torc::generic::Bundle< _Type >::addChild	(	const boost::shared_ptr< Type > &	child	)
throw	(	Error
	)

virtual

Add a child to the bundle. Note that, the new element is added to the end of the array.

Parameters

[in] child A pointer to a child

Exceptions

Error The composition is not a container or the child type is not proper

Definition at line 145 of file Bundle.hpp.

                   {
     mChildren.push_back(child);
     child->setParentCollection(SelfReferencing<_Type>::getSharedThis());
 }

template<typename _Type >

template<typename _Action >

void torc::generic::Bundle< _Type >::applyOnAllChildren	(	const _Action &	action	)
throw	(	Error
	)

Definition at line 162 of file Bundle.hpp.

                                          {
     try {
         std::for_each(mChildren.begin(), mChildren.end(), action);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 
 }

Here is the call graph for this function:

template<typename _Type>

const Bundle< _Type >::Pointer torc::generic::Bundle< _Type >::get	(	const std::vector< SizeType > &	indices	)	const
throw	(	Error
	)

virtual

Get a specific member of this composition.

Returns: An empty pointer is returned

Exceptions

Error Index dimensions mismatch

Implements torc::generic::Composite< _Type >.

Definition at line 180 of file Bundle.hpp.

                                                                                   {
     return Pointer();
 }

template<typename _Type>

void torc::generic::Bundle< _Type >::getChildren	(	List &	outChildren	)	const
throw	(	Error
	)

virtual

Get children of this composition.

Parameters

[out] outChildren A list of all children for this composition

Implements torc::generic::Composite< _Type >.

Definition at line 156 of file Bundle.hpp.

                                                                  {
     outChildren.insert(outChildren.end(), mChildren.begin(), mChildren.end());
     return;
 }

Here is the caller graph for this function:

template<typename _Type >

CompositionType torc::generic::Bundle< _Type >::getCompositionType ( ) const

virtual

Get composition type for this object

Returns: The CompositionType inSource VECTOR is returned

Implements torc::generic::Composite< _Type >.

Definition at line 121 of file Bundle.hpp.

                                                                                   {
     return eCompositionTypeBundle;
 }

template<typename _Type >

Composite< _Type >::Pointer torc::generic::Composite< _Type >::getParentCollection ( ) const

inlinevirtualinherited

Get a pointer to the parent collection

Returns: A pointer to the parent collection if present, empty pointer otherwise

Definition at line 156 of file Composite.hpp.

                                                 {
     return mParentCollection.lock();
 }

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

template<typename _Type >

Bundle< _Type >::SizeType torc::generic::Bundle< _Type >::getSize ( void ) const

virtual

Get the total number of bits of the composition

Returns: Number of bits

Implements torc::generic::Composite< _Type >.

Definition at line 129 of file Bundle.hpp.

                                                                                       {
     size_t size = 0;
     for(typename Bundle<_Type>::List::const_iterator it = mChildren.begin(); it != mChildren.end();
         ++it) {
         size += (*it)->getSize();
     }
     return size;
 }

template<typename _Type>

void torc::generic::Composite< _Type >::setParentCollection ( const Pointer & inParentCollection )

inlinevirtualinherited

Set a pointer to a parnt composition.

Parameters

[in] inParentCollection pointer to the parent collection (Vector/Bundle)

Set a pointer to a parnt composition.

Parameters

[in] parentCollection pointer to the parent collection (Vector/Bundle)

Definition at line 145 of file Composite.hpp.

                                                                 {
     mParentCollection = inParentCollection;
 }

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

Field Documentation

template<typename _Type>

List torc::generic::Bundle< _Type >::mChildren

private

Definition at line 109 of file Bundle.hpp.

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

Bundle.hpp

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

template<typename _Type> class torc::generic::Bundle< _Type >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

template<typename _Type>
class torc::generic::Bundle< _Type >