Represents a member of an instance array. More...

#include <InstanceArrayMember.hpp>

Inheritance diagram for torc::generic::InstanceArrayMember:

Collaboration diagram for torc::generic::InstanceArrayMember:

Public Types
typedef VisitorType < InstanceArrayMember >	Visitor

typedef FactoryType < InstanceArrayMember >	Factory

typedef Instance	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

typedef std::vector< Pointer >	List

typedef size_t	SizeType

typedef std::string	Name

typedef Instance	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 ParameterContext	getParameterContext () const

virtual ParameterMapSharedPtr	getParameters () const throw (Error)

	InstanceArrayMember ()

virtual	~InstanceArrayMember () throw ()

ViewSharedPtr	getMaster () const

virtual void	bindToMasterView (const ViewSharedPtr &inMaster, bool inMapPortReferences=true) throw (Error)

virtual void	addPortReference (const PortReferenceSharedPtr &inPortRef) throw (Error)

virtual PortReferenceSharedPtr	findPortReference (const std::string &inPortRef) throw (Error)

virtual NetReferenceSharedPtr	findNetReference (const std::string &inNetRef) throw (Error)

virtual void	removePortReference (const std::string &inName) throw (Error)

virtual void	getPortReferences (std::vector< PortReferenceSharedPtr > &) const

virtual void	setPortReferences (const std::vector< PortReferenceSharedPtr > &inSource) throw (Error)

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

const std::string	getDesignator () const

void	setDesignator (const std::string &inSource)

const TimingSharedPtr	getTiming () const

void	setTiming (const TimingSharedPtr &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

void	addComment (const std::string &comment)

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

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

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)

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
void	setMaster (const ViewSharedPtr &inMaster)

Detailed Description

Represents a member of an instance array.

The InstanceArrayMember represents a single instance from an array of instances.

Definition at line 41 of file InstanceArrayMember.hpp.

Member Typedef Documentation

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

inherited

Definition at line 47 of file VectorBit.hpp.

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

Convenience typedef to create a parameter array element.

Definition at line 50 of file InstanceArrayMember.hpp.

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

inherited

Definition at line 48 of file VectorBit.hpp.

typedef std::vector<Pointer> torc::generic::Composite< Instance >::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< Instance >::Pointer

inherited

Definition at line 49 of file VectorBit.hpp.

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

inherited

Shared Pointer to object of type Type

Definition at line 55 of file Composite.hpp.

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

inherited

Definition at line 50 of file VectorBit.hpp.

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

inherited

Definition at line 62 of file Composite.hpp.

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

inherited

Definition at line 46 of file VectorBit.hpp.

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

inherited

Definition at line 50 of file Composite.hpp.

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

Definition at line 46 of file InstanceArrayMember.hpp.

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

inherited

Definition at line 56 of file Composite.hpp.

Constructor & Destructor Documentation

torc::generic::InstanceArrayMember::InstanceArrayMember ( )

Definition at line 79 of file InstanceArrayMember.cpp.

79 : Instance(), VectorBit<Instance>() {}

torc::generic::Instance::Instance

Instance()

Definition: generic/Instance.cpp:260

torc::generic::InstanceArrayMember::~InstanceArrayMember	(	)
throw	(
	)

virtual

Definition at line 81 of file InstanceArrayMember.cpp.

81 {}

Member Function Documentation

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

virtual

Receive an inoutVisitor to this class. The visit method of the inoutVisitor 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 inoutVisitor specialization. See Visitor documentation for more details.

Parameters

[in,out] inoutVisitor A reference to the inoutVisitor 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 47 of file InstanceArrayMember.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::Instance::addPortReference	(	const PortReferenceSharedPtr &	inPortRef	)
throw	(	Error
	)

virtualinherited

Add a port reference to this master. When a master is set using the set_master(), the list of port references is not created. It has to be extrinsically set.

Parameters

[in] inPortRef A port reference.

Exceptions

Error	The port ref could not be added, because PortReference name is empty Id : eMessageIdErrorEmptyItemName Context Data PortReference name - String
Error	The port ref could not be added, because PortReference name is already exists Id : eMessageIdErrorItemAlreadyExists Context Data PortReference name - String

Add a port reference to this master. When a master is set using the set_master(), the list of port references is not created. It has to be extrinsically set.

Parameters

[in] inPortRef A port reference.

Exceptions

Error The port ref could not be added.

Reimplemented in torc::generic::InstanceArray.

Definition at line 159 of file generic/Instance.cpp.

                                                                                      {
     std::string name = inPortRef->getName();
     if(name.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("PortReference name", name);
         throw e;
     }
     if(false == mPortReferences.set(name, inPortRef)) {
         Error e(eMessageIdErrorItemAlreadyExists, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("PortReference name", name);
         throw e;
     }
     inPortRef->setParent(getSharedThis());
     return;
 }

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

template<typename _Action >

void torc::generic::Instance::applyOnAllPortReferences	(	const _Action &	action	)
throw	(	Error
	)

inlineinherited

Apply action on all PortReferences.

Parameters

[in] action Action to be applied

Definition at line 292 of file generic/Instance.hpp.

                   {
     try {
         mPortReferences.applyOnAll(action);
     } 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:

void torc::generic::Instance::bindToMasterView	(	const ViewSharedPtr &	inMaster,
		bool	inMapPortReferences = `true`
	)
throw	(	Error
	)

virtualinherited

Bind an instance to it's master. Instance binding consists of two steps:

Bind instance to cell
Bind existing port references to ports of the cell

Note: Instances can be bound in two states, namely, immediately, with no port reference bindings, or delayed, when all used port references are bound to master ports. There is no port binding for extern views.

Parameters

[in]	inMaster	Source Master view for this instance.
[in]	inMapPortReferences	Whether port references are to be mapped to ports of the new master

Exceptions

Error If there is any kind of mismatch between ports etc.

Bind an instance to it's master. Instance binding consists of two steps:

Bind instance to cell
Bind port references to ports of the cell

Parameters

[in] inMaster Source Master view for this instance.

Exceptions

Error If there is any kind of mismatch between ports etc.

Reimplemented in torc::generic::InstanceArray.

Definition at line 103 of file generic/Instance.cpp.

                   {
     if(!mMaster) {
         //TDB::ERROR MASTER REBINDING NOT ALLOWED
     }
     ViewSharedPtr oldMaster = getMaster();
     std::map<std::string, ParameterSharedPtr> myParams;
     if(oldMaster) {
         ParameterMapSharedPtr oldParams = oldMaster->getParameters();
         oldParams->getOverriddenParameters(mMyContext, myParams);
         oldParams->unregisterContext(mMyContext);
     }
     setMaster(inMaster);
     ParameterMapSharedPtr paramMap = mMaster->getParameters();
     mMyContext = paramMap->getNewContext();
     //We do not create params here, they will be created only when
     //someone asks for params
     //For rebinding, however, if some params were there
     //.. we have to override them on the new master
     if(!myParams.empty()) {
         try {
             paramMap->registerContext(mMyContext, mMaster->getParameterContext());
             for(std::map<std::string, ParameterSharedPtr>::iterator it = myParams.begin();
                 it != myParams.end(); ++it) {
                 paramMap->set(mMyContext, (*it).first, (*it).second);
             }
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
     if(inMaster->getIsExtern()) {
         return; //No port binding for extern
     }
     if(inMapPortReferences) {
         PortMapper mapper(inMaster);
         try {
             mPortReferences.applyOnAll(mapper);
         } 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:

NetReferenceSharedPtr torc::generic::Instance::findNetReference	(	const std::string &	inName	)
throw	(	Error
	)

virtualinherited

Find a Net reference.

Parameters

[in] inName String containing the name of the Net.

Definition at line 191 of file generic/Instance.cpp.

                                                                                       {
     NetReferenceSharedPtr netRef;
     mNetReferences.get(inName, netRef);
     return netRef;
 }

PortReferenceSharedPtr torc::generic::Instance::findPortReference	(	const std::string &	inName	)
throw	(	Error
	)

virtualinherited

Find a port reference.

Parameters

[in] inName String containing the name of the port.

Reimplemented in torc::generic::InstanceArray.

Definition at line 180 of file generic/Instance.cpp.

                                                                                         {
     PortReferenceSharedPtr portRef;
     mPortReferences.get(inName, portRef);
     return portRef;
 }

virtual const Pointer torc::generic::VectorBit< Instance >::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< Instance >.

virtual const Pointer torc::generic::Composite< Instance >::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< Instance, InstanceArrayMember, InstanceArrayMember::Factory, false >, torc::generic::VectorBit< Instance >, and torc::generic::Scalar< Instance >.

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

inlineinherited

virtual void torc::generic::VectorBit< Instance >::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< Instance >.

virtual void torc::generic::Composite< Instance >::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< Instance, InstanceArrayMember, InstanceArrayMember::Factory, false >, torc::generic::Scalar< Instance >, and torc::generic::VectorBit< Instance >.

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< Instance >::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< Instance >.

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

pure virtualinherited

Get the type of this composition.

Returns: Composition type for this object

Implemented in torc::generic::Vector< Instance, InstanceArrayMember, InstanceArrayMember::Factory, false >, torc::generic::VectorBit< Instance >, and torc::generic::Scalar< Instance >.

const std::string torc::generic::Instance::getDesignator ( ) const

inlineinherited

Get the designated number.

Returns: std::string Value representing designated number of a view interface.

Definition at line 302 of file generic/Instance.hpp.

                                                      {
     return mDesignator;
 }

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

inlineinherited

Get the index of this bit in the vector.

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

ViewSharedPtr torc::generic::Instance::getMaster ( ) const

inlineinherited

Get the master view for this instance.

Returns: Master view for this instance.

Definition at line 283 of file generic/Instance.hpp.

                                                {
     return mMaster;
 }

Here is the caller graph for this function:

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:

ParameterContext torc::generic::InstanceArrayMember::getParameterContext ( ) const

virtual

Returns the parent container's context that will be used to get parameters from the parameter map. For an unbound instance, this will return an invalid value

Reimplemented from torc::generic::Instance.

Definition at line 56 of file InstanceArrayMember.cpp.

                                                                 {
     InstanceSharedPtr parent = getParentCollection();
     if(!parent) {
         return ParameterContext();
     }
     return parent->getParameterContext();
 }

Here is the call graph for this function:

ParameterMapSharedPtr torc::generic::InstanceArrayMember::getParameters	(		)	const
throw	(	Error
	)

virtual

Get the ParameterMap corresponding to this instance and it's master

Returns: A ParameterMap consisiting of only the overridden parameters.

Reimplemented from torc::generic::Instance.

Definition at line 69 of file InstanceArrayMember.cpp.

                                                                              {
     InstanceSharedPtr parent = getParentCollection();
     if(!parent) {
         Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Parent Collection", parent);
         throw e;
     }
     return parent->getParameters();
 }

Here is the call 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< Instance >::getParentCollection ( ) const

inlinevirtualinherited

Get a pointer to the parent collection

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

Here is the caller graph for this function:

void torc::generic::Instance::getPortReferences ( std::vector< PortReferenceSharedPtr > & outPortRefs ) const

virtualinherited

Get list of all port references.

Returns: List of port references

Get list of all port references.

Parameters

[out] outPortRefs List of port references

Reimplemented in torc::generic::InstanceArray.

Definition at line 224 of file generic/Instance.cpp.

                                                                                      {
     mPortReferences.getValues(outPortRefs);
 }

Here is the call graph for this function:

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< Instance >::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< Instance >::getSize ( void ) const

virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

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

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

pure virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

Implemented in torc::generic::Vector< Instance, InstanceArrayMember, InstanceArrayMember::Factory, false >, torc::generic::VectorBit< Instance >, and torc::generic::Scalar< Instance >.

const TimingSharedPtr torc::generic::Instance::getTiming ( ) const

inlineinherited

Get the pointer to the timing object

Returns: Pointer to the timing object

Definition at line 311 of file generic/Instance.hpp.

                                                        {
     return mTiming;
 }

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::Instance::removePortReference	(	const std::string &	inName	)
throw	(	Error
	)

virtualinherited

Remove a given port reference.

Parameters

inName Name of the object to be delete

Exceptions

Error	PortReference name is empty Id : eMessageIdErrorEmptyItemName Context Data PortReference name - String
Error	PortReference name could not be found Id : eMessageIdErrorItemNotFound Context Data PortReference name - String

Remove a given port reference.

Parameters

inName Name of the object to be delete

Exceptions

Error	PortReference name is empty
Error	PortReference name could not be found

Reimplemented in torc::generic::InstanceArray.

Definition at line 205 of file generic/Instance.cpp.

                                                                         {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("PortReference name", inName);
         throw e;
     }
     if(false == mPortReferences.remove(inName)) {
         Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("PortReference name", inName);
         throw e;
     }
     return;
 }

Here is the call graph for this function:

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

inherited

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::Instance::setDesignator ( const std::string & inSource )

inherited

Set the designated number.

Parameters

[in] inSource std::string representing designated number of a view interface.

Definition at line 247 of file generic/Instance.cpp.

                                                       {
     mDesignator = inSource;
 }

void torc::generic::VectorBit< Instance >::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::Instance::setMaster ( const ViewSharedPtr & inMaster )

protectedinherited

Definition at line 148 of file generic/Instance.cpp.

                                                       {
     mMaster = inMaster;
 }

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< Instance >::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::Instance::setPortReferences	(	const std::vector< PortReferenceSharedPtr > &	inSource	)
throw	(	Error
	)

virtualinherited

Set list of all port references.

Parameters

[in] inSource List of port references

Reimplemented in torc::generic::InstanceArray.

Definition at line 233 of file generic/Instance.cpp.

                                                                                                 {
     std::vector<PortReferenceSharedPtr>::const_iterator portRef = inSource.begin();
     std::vector<PortReferenceSharedPtr>::const_iterator endP = inSource.end();
     for(; portRef != endP; ++endP) {
         try {
             addPortReference(*portRef);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
     return;
 }

Here is the call graph for this function:

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::Instance::setTiming ( const TimingSharedPtr & inSource )

inherited

Set the pointer to the timing object

Parameters

[in] inSource Pointer to the timing object

Definition at line 256 of file generic/Instance.cpp.

                                                         {
     mTiming = 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< Instance >::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

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