Represents a bit of a port. More...

#include <VectorPortBit.hpp>

Inheritance diagram for torc::generic::VectorPortBit:

Collaboration diagram for torc::generic::VectorPortBit:

Public Types
typedef FactoryType < VectorPortBit >	Factory

typedef VisitorType < VectorPortBit >	Visitor

typedef std::list < NetSharedPtr >::iterator	Connection

typedef boost::signals2::signal< void(const NetSharedPtr &)>	Connected

typedef boost::signals2::signal< void(const NetSharedPtr &)>	Disconnected

typedef std::string	Name

typedef Port	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

typedef std::vector< Pointer >	List

typedef size_t	SizeType

typedef Port	Type

typedef Composite< Type >	BaseType

typedef BaseType::List	List

typedef BaseType::Pointer	Pointer

typedef BaseType::SizeType	SizeType

Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)

virtual Connection	connect (const NetSharedPtr &inNet) throw (Error)

virtual void	disconnect (const Connection &inConnection) throw (Error)

virtual void	getConnectedNets (std::vector< NetSharedPtr > &outNets, bool inSkipChildConnections=false) const throw (Error)

	VectorPortBit ()

	~VectorPortBit () throw ()

const EPortDirection	getDirection () const

void	setDirection (const EPortDirection &inSource)

const PortAttributesSharedPtr	getAttributes () const

void	setAttributes (const PortAttributesSharedPtr &inSource)

void	addComment (const std::string &comment)

const std::vector< std::string > &	getComments () const

void	setComments (const std::vector< std::string > &inSource)

Connected &	signalNetConnected ()

Disconnected &	signalNetDisconnected ()

void	disconnect (const std::string &inName) throw (Error)

void	disconnect (const NetSharedPtr &net) throw (Error)

virtual void	disconnect () throw (Error)

bool	getIsExtern () const

bool	isExtern () const

void	setIsExtern (bool inIsExtern)

virtual const std::string	getName () const

void	setName (const std::string &inSource) throw (Error)

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)

virtual Name	getOriginalName () const

virtual void	setOriginalName (const Name &inSource)

virtual CompositionType	getCompositionType () const =0

virtual size_t	getSize () const =0

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

virtual const Pointer	get (const std::vector< SizeType > &inIndices) const =0 throw (Error)

virtual void	setParentCollection (const Pointer &inParentCollection)

virtual Pointer	getParentCollection () const

void	setWeakThis (const WeakPointer &inWeakThis)

Pointer	getSharedThis () const

const boost::shared_ptr< View >	getParent () const

virtual void	setParent (const boost::shared_ptr< View > &inSource)

void	getUserData (std::list< std::string > &outUserData) const

void	setUserData (const std::list< std::string > &inSource)

void	addUserData (const std::string &inSource)

virtual CompositionType	getCompositionType () const

virtual SizeType	getSize () const

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

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

const std::vector< SizeType > &	getIndices () const

void	setIndices (const std::vector< SizeType > &inSource)

SizeType	getAbsoluteIndex () const

void	setAbsoluteIndex (SizeType inSource)

Protected Member Functions
virtual void	onConnect () throw (Error)

virtual void	onDisconnect () throw (Error)

Detailed Description

Represents a bit of a port.

The VectorPortBit class represents a bit of an array port. Such objects cannot be created in EDIF. They are automatically created when a particular member of an array is accessed using the (member ...) syntax.

Definition at line 43 of file VectorPortBit.hpp.

Member Typedef Documentation

typedef Composite<Type> torc::generic::VectorBit< Port >::BaseType

inherited

Definition at line 47 of file VectorBit.hpp.

typedef boost::signals2::signal<void(const NetSharedPtr&)> torc::generic::Connectable::Connected

inherited

A signal to indicate that a new connection has been made

Definition at line 57 of file Connectable.hpp.

typedef std::list<NetSharedPtr>::iterator torc::generic::Connectable::Connection

inherited

A connection between a net and this object

Definition at line 52 of file Connectable.hpp.

typedef boost::signals2::signal<void(const NetSharedPtr&)> torc::generic::Connectable::Disconnected

inherited

A signal to indicate that a connection has been removed

Definition at line 62 of file Connectable.hpp.

typedef FactoryType<VectorPortBit> torc::generic::VectorPortBit::Factory

Definition at line 49 of file VectorPortBit.hpp.

typedef BaseType::List torc::generic::VectorBit< Port >::List

inherited

Definition at line 48 of file VectorBit.hpp.

typedef std::vector<Pointer> torc::generic::Composite< Port >::List

inherited

List of Shared Pointers to objects of type Type

Definition at line 61 of file Composite.hpp.

typedef std::string torc::generic::Renamable::Name

inherited

Definition at line 40 of file generic/Renamable.hpp.

typedef BaseType::Pointer torc::generic::VectorBit< Port >::Pointer

inherited

Definition at line 49 of file VectorBit.hpp.

typedef boost::shared_ptr<Type> torc::generic::Composite< Port >::Pointer

inherited

Shared Pointer to object of type Type

Definition at line 55 of file Composite.hpp.

typedef BaseType::SizeType torc::generic::VectorBit< Port >::SizeType

inherited

Definition at line 50 of file VectorBit.hpp.

typedef size_t torc::generic::Composite< Port >::SizeType

inherited

Definition at line 62 of file Composite.hpp.

typedef Port torc::generic::VectorBit< Port >::Type

inherited

Definition at line 46 of file VectorBit.hpp.

typedef Port torc::generic::Composite< Port >::Type

inherited

Definition at line 50 of file Composite.hpp.

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

Definition at line 50 of file VectorPortBit.hpp.

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

inherited

Definition at line 56 of file Composite.hpp.

Constructor & Destructor Documentation

torc::generic::VectorPortBit::VectorPortBit ( )

Definition at line 136 of file VectorPortBit.cpp.

136 : Port(), VectorBit<Port>() {}

torc::generic::Port::Port

Port()

Definition: generic/Port.cpp:34

torc::generic::VectorPortBit::~VectorPortBit	(	)
throw	(
	)

Definition at line 138 of file VectorPortBit.cpp.

                                        {
     torc::generic::log("Vector Port bit destroyed\n");
 }

Here is the call graph for this function:

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 38 of file VectorPortBit.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::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::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:

Connectable::Connection torc::generic::VectorPortBit::connect	(	const NetSharedPtr &	inNet	)
throw	(	Error
	)

virtual

Implements torc::generic::Connectable.

Definition at line 47 of file VectorPortBit.cpp.

                                                                                     {
     if(!inNet) {
         Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Pointer to the Net object does not exist", inNet);
         throw e;
     }
     if(inNet->getSize() != getSize()) {
         Error e(eMessageIdErrorItemSizeMismatch, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Net Size", inNet->getSize());
         e.saveContextData("Vector port bit Size", getSize());
         throw e;
     }
     Connectable::Connection newConnection;
     try {
         ConnectionHandler handler(inNet);
         handler.connectPortToNet(getSharedThis());
         newConnection = Connectable::connect(inNet);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
     return newConnection;
 }

Here is the call graph for this function:

void torc::generic::VectorPortBit::disconnect	(	const Connection &	inConnection	)
throw	(	Error
	)

virtual

Implements torc::generic::Connectable.

Definition at line 71 of file VectorPortBit.cpp.

                                                                            {
     NetSharedPtr net = *inConnection;
     if(!net) {
         Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Pointer to the Net object does not exist", net);
         throw e;
     }
     try {
         ConnectionHandler handler(net);
         handler.disconnectPortFromNet(getSharedThis());
         Connectable::disconnect(inConnection);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

void torc::generic::Connectable::disconnect	(	const std::string &	inName	)
throw	(	Error
	)

inherited

Disconnect the named Net from this object.

Note: This metod can be overridden by derived classes. However, the method must call the on_connected() method after this. The sigConnected_ signal must also be invoked in the overriding method.

Parameters

[in] inName Name of the net to be Disconnected

Exceptions

Error Provided net was not found

Disconnect the named Net from this object.

Note: This metod can be overridden by derived classes. However, the method must call the on_connected() method after this. The sigConnected_ signal must also be invoked in the overriding method.

Parameters

[in] inNname Name of the net to be Disconnected

Exceptions

Error Provided net was not found

Definition at line 111 of file Connectable.cpp.

                                                                   {
     disconnect(std::find_if(mConnectedNets.begin(), mConnectedNets.end(),
         boost::bind<bool>(std::equal_to<std::string>(),
         boost::bind(boost::mem_fn(&Net::getName), _1), inName)));
 }

Here is the call graph for this function:

void torc::generic::Connectable::disconnect	(	const NetSharedPtr &	inNet	)
throw	(	Error
	)

inherited

Disconnect the given Net from this object.

Note: This metod can be overridden by derived classes. However, the method must call the on_disconnected() method after this. The sigDisconnected_ signal must also be invoked in the overriding method.

Parameters

[in] net Pointer to a net

Exceptions

Error Provided net was not found

Disconnect the given Net from this object.

Note: This metod can be overridden by derived classes. However, the method must call the on_disconnected() method after this. The sigDisconnected_ signal must also be invoked in the overriding method.

Parameters

[in] inNet Pointer to a net

Exceptions

Error Provided net was not found

Definition at line 128 of file Connectable.cpp.

                                                                     {
     disconnect(std::find(mConnectedNets.begin(), mConnectedNets.end(), inNet));
 }

void torc::generic::Connectable::disconnect	(		)
throw	(	Error
	)

virtualinherited

Disconnect all connections to this port.

Reimplemented in torc::generic::Net, torc::generic::VectorNet, and torc::generic::NetBundle.

Definition at line 132 of file Connectable.cpp.

                                            {
     log("Disconnecting all\n");
     std::vector<NetSharedPtr> nets;
     getConnectedNets(nets, true);
     for(std::vector<NetSharedPtr>::iterator it = nets.begin(); it != nets.end(); ++it) {
         disconnect(*it);
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const Pointer torc::generic::VectorBit< Port >::get	(	const std::vector< SizeType > &	inIndices	)	const
throw	(	Error
	)

virtualinherited

Get a specific member of this composition.

Parameters

[in] inIndices A list of indices to be accessed. The number of indices must be equal to the number of dimensions.

Returns: An empty pointer is returned

Get a specific member of this composition.

Parameters

[in] indices A list of indices to be accessed. The number of indices must be equal to the number of dimensions.

Returns: An empty pointer is returned

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

virtual const Pointer torc::generic::Composite< Port >::get	(	const std::vector< SizeType > &	inIndices	)	const
throw	(	Error
	)

pure virtualinherited

Get a specific member of this composition.

Note: This is relevant for Vector composition only. Other compositions return a NULL pointer

Parameters

[in] inIndices A list of indices to be accessed. The number of indices must be equal to the number of dimensions.

Returns: A pointer to the child situated at the specified indices. For non-relevant types a NULL pointer is returned

Exceptions

Error Index dimensions mismatch

Implemented in torc::generic::Vector< Port, VectorPortBit, VectorPortBit::Factory, true >, torc::generic::Bundle< Port >, torc::generic::VectorBit< Port >, and torc::generic::Scalar< Port >.

SizeType torc::generic::VectorBit< Port >::getAbsoluteIndex ( ) const

inlineinherited

const PortAttributesSharedPtr torc::generic::Port::getAttributes ( ) const

inlineinherited

Get the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.

Returns: Pointer to PortAttributes object.

Definition at line 123 of file generic/Port.hpp.

                                                                {
     return mAttributes;
 }

virtual void torc::generic::VectorBit< Port >::getChildren	(	List &	outChildren	)	const
throw	(	Error
	)

virtualinherited

Get children of this composition.

Parameters

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

Note: This wil return empty list for scalar

Get children of this composition.

Parameters

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

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

virtual void torc::generic::Composite< Port >::getChildren	(	List &	outChildren	)	const
throw	(	Error
	)

pure virtualinherited

Get children of this composition.

Note: This is relevant for Vector and Bundle compositions only. Other compositions return a NULL pointer

Parameters

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

Implemented in torc::generic::Vector< Port, VectorPortBit, VectorPortBit::Factory, true >, torc::generic::Scalar< Port >, and torc::generic::VectorBit< Port >.

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

virtual CompositionType torc::generic::VectorBit< Port >::getCompositionType ( ) const

virtualinherited

Get composition type for this object

Returns: The CompositionType inSource eCompositionTypeVectorBit is returned

Get composition type for this object

Returns: The CompositionType inSource eCompositionTypeScalar is returned

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

virtual CompositionType torc::generic::Composite< Port >::getCompositionType ( ) const

pure virtualinherited

Get the type of this composition.

Returns: Composition type for this object

Implemented in torc::generic::Vector< Port, VectorPortBit, VectorPortBit::Factory, true >, torc::generic::Bundle< Port >, torc::generic::VectorBit< Port >, and torc::generic::Scalar< Port >.

void torc::generic::VectorPortBit::getConnectedNets	(	std::vector< NetSharedPtr > &	outNets,
		bool	inSkipChildConnections = `false`
	)		const
throw	(	Error
	)

virtual

Reimplemented from torc::generic::Connectable.

Definition at line 88 of file VectorPortBit.cpp.

                                                      {
     //First get connections exclusive to me
     Port::getConnectedNets(outNets);
 
     //Append cousins from nets that have been connected to my
     //parent
     if(!inSkipChildConnections) {
         VectorBit<Net>::List parentConnections;
         Composite<Port>::Pointer parent = getParentCollection();
         if(!parent) {
             Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
             e.saveContextData("Pointer to parent collection does not exist", parent);
             throw e;
         }
         if(eCompositionTypeVector != parent->getCompositionType()) {
             Error e(eMessageIdErrorCompositionTypeMismatch, __FUNCTION__, __FILE__, __LINE__);
             e.saveContextData("Composition type mismatch", parent->getCompositionType());
             throw e;
         }
         parent->getConnectedNets(parentConnections, true);
         VectorBit<Net>::List::iterator connNet = parentConnections.begin();
         VectorBit<Net>::List::iterator connNetEnd = parentConnections.end();
         const std::vector<VectorBit<Net>::SizeType>& myIndex = getIndices();
         for(; connNet != connNetEnd; ++connNet) {
             Composite<Net>::Pointer cousin;
             if(eCompositionTypeVector == (*connNet)->getCompositionType()) {
                 cousin = (*connNet)->get(myIndex);
                 //We don't want to mess up preservervation
                 //by calling getChildren()
             } else //Must be a bundle
             {
                 VectorBit<Net>::List bChildren;
                 (*connNet)->getChildren(bChildren);
                 cousin = bChildren[getAbsoluteIndex()];
                 //We assume list is a vector
             }
             if(!cousin) {
                 Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
                 e.saveContextData("Pointer to item does not exist", cousin);
                 throw e;
             }
             outNets.push_back(cousin);
         }
     }
     return;
 }

Here is the call graph for this function:

const EPortDirection torc::generic::Port::getDirection ( ) const

inlineinherited

Get the direction of port

Returns: Direction of port

Definition at line 114 of file generic/Port.hpp.

                                                      {
     return mDirection;
 }

Here is the caller graph for this function:

const std::vector<SizeType>& torc::generic::VectorBit< Port >::getIndices ( ) const

inlineinherited

Get the index of this bit in the vector.

Returns: A vector containing the indices to which this element belonged.

bool torc::generic::Extern::getIsExtern ( ) const

inlineinherited

Get whether the item is an extern(placeholder) or an actual item.

Returns: True if extern, false otherwise

Definition at line 86 of file Extern.hpp.

                                       {
     return mIsExtern;
 }

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<View > torc::generic::ParentedObject< View >::getParent ( ) const

inlineinherited

Get a pointer to the parent object

Returns: Pointer to parent

Here is the caller graph for this function:

virtual Pointer torc::generic::Composite< Port >::getParentCollection ( ) const

inlinevirtualinherited

Get a pointer to the parent collection

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

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:

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

virtual SizeType torc::generic::VectorBit< Port >::getSize ( void ) const

virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

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

virtual size_t torc::generic::Composite< Port >::getSize ( void ) const

pure virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

Implemented in torc::generic::Vector< Port, VectorPortBit, VectorPortBit::Factory, true >, torc::generic::Bundle< Port >, torc::generic::VectorBit< Port >, and torc::generic::Scalar< Port >.

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

bool torc::generic::Extern::isExtern ( ) const

inlineinherited

Get whether the item is an extern(placeholder) or an actual item.

Returns: True if extern, false otherwise

Definition at line 95 of file Extern.hpp.

                                    {
     return mIsExtern;
 }

void torc::generic::Connectable::onConnect	(		)
throw	(	Error
	)

protectedvirtualinherited

A polymorphic function that is called after a net is Connected to this object

Definition at line 144 of file Connectable.cpp.

144 {}

void torc::generic::Connectable::onDisconnect	(		)
throw	(	Error
	)

protectedvirtualinherited

A polymorphic function that is called after a net is Disconnected from this object

Definition at line 149 of file Connectable.cpp.

149 {}

void torc::generic::VectorBit< Port >::setAbsoluteIndex ( SizeType inSource )

inherited

void torc::generic::Port::setAttributes ( const PortAttributesSharedPtr & inSource )

inherited

Set the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.

Note: This method does not check whether prior set of properties exist or not. Newly set property will remove old properties.

Parameters

[in] inSource Pointer to PortAttributes object.

Definition at line 56 of file generic/Port.cpp.

                                                                 {
     mAttributes = inSource;
 }

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::Port::setDirection ( const EPortDirection & inSource )

inherited

Set the direction of port

Parameters

[in] inSource Direction of port

Definition at line 45 of file generic/Port.cpp.

                                                       {
     mDirection = inSource;
 }

void torc::generic::VectorBit< Port >::setIndices ( const std::vector< SizeType > & inSource )

inherited

Set the index of this bit in the vector.

Parameters

[in] inSource A vector of indices for this element

void torc::generic::Extern::setIsExtern ( bool inIsExtern )

inherited

Set whether an item is extern or not.

Parameters

[in] isExtern True if extern, false otherwise

Definition at line 35 of file Extern.cpp.

                                         {
     mIsExtern = inIsExtern;
 }

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< View >::setParent ( const boost::shared_ptr< View > & inSource )

virtualinherited

Set a pointer to the parent

Parameters

[in] inSource Set a pointer to the parent

Here is the caller graph for this function:

virtual void torc::generic::Composite< Port >::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)

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::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< Port >::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

Connectable::Connected & torc::generic::Connectable::signalNetConnected ( )

inlineinherited

A signal to indicate that a new connection has been made

Definition at line 167 of file Connectable.hpp.

                                                              {
     return mSigNetConnected;
 }

Connectable::Disconnected & torc::generic::Connectable::signalNetDisconnected ( )

inlineinherited

A signal to indicate that a new connection has been made

Definition at line 174 of file Connectable.hpp.

                                                                    {
     return mSigNetDisconnected;
 }

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

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation