Represents an array of instances. More...

#include <InstanceArray.hpp>

Inheritance diagram for torc::generic::InstanceArray:

Collaboration diagram for torc::generic::InstanceArray:

Data Structures
class	Factory

Public Types
typedef Vector< Instance, InstanceArrayMember, InstanceArrayMember::Factory, false >	BaseVectorType

typedef VisitorType < InstanceArray >	Visitor

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 Composite< Instance >	BaseType

typedef BaseType::Type	Type

typedef BaseType::List	List

typedef BaseType::Pointer	Pointer

typedef BaseType::SizeType	SizeType

typedef InstanceArrayMember	ChildType

typedef boost::shared_ptr < ChildType >	ChildPointer

typedef InstanceArrayMember::Factory	ChildFactory

typedef boost::shared_ptr < InstanceArrayMember::Factory >	ChildFactorySharedPtr

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

virtual void	setParent (const ViewSharedPtr &inParent)

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 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	applyOnAllBits (const _Action &action) throw (Error)

virtual	~InstanceArray () throw ()

virtual ParameterContext	getParameterContext () const

virtual ParameterMapSharedPtr	getParameters () const throw (Error)

ViewSharedPtr	getMaster () const

virtual NetReferenceSharedPtr	findNetReference (const std::string &inNetRef) 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 const Pointer	get (const std::vector< SizeType > &inIndices) const throw (Error)

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

void	applyOnAllChildren (const _Action &action) throw (Error)

virtual void	forceAutoBlast (void) throw (Error)

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

void	constructChildren (const boost::shared_ptr< ChildFactory > &inFactory, const std::vector< SizeType > &inLimits) throw (Error)

void	getLimits (std::vector< SizeType > &outLimits) const

bool	getIsPreserved () const

Protected Member Functions
virtual void	onChildCreate (const boost::shared_ptr< BaseVectorType::ChildType > &inCreatedChild) const throw (Error)

	InstanceArray ()

void	setMaster (const ViewSharedPtr &inMaster)

void	setChildren (const List &inSource) throw (Error)

virtual void	onAutoBlast () const throw (Error)

virtual void	onChildCreate (const boost::shared_ptr< ChildType > &inCreatedChild) const throw (Error)

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

const boost::shared_ptr < ChildFactory >	getFactory () const

void	setFactory (const boost::shared_ptr< ChildFactory > &inSource)

Friends
class	FactoryType< InstanceArray >

Detailed Description

Represents an array of instances.

The InstanceArray class represents an array of instances. They can be created using the (instance (array ...) ... ) syntax.

Definition at line 47 of file InstanceArray.hpp.

Member Typedef Documentation

typedef Composite<Instance > torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::BaseType

inherited

Definition at line 55 of file Vector.hpp.

typedef Vector<Instance, InstanceArrayMember, InstanceArrayMember::Factory, false> torc::generic::InstanceArray::BaseVectorType

Definition at line 56 of file InstanceArray.hpp.

typedef InstanceArrayMember::Factory torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::ChildFactory

inherited

Definition at line 62 of file Vector.hpp.

typedef boost::shared_ptr<InstanceArrayMember::Factory > torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::ChildFactorySharedPtr

inherited

Definition at line 63 of file Vector.hpp.

typedef boost::shared_ptr<ChildType> torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::ChildPointer

inherited

Definition at line 61 of file Vector.hpp.

typedef InstanceArrayMember torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::ChildType

inherited

Definition at line 60 of file Vector.hpp.

typedef BaseType::List torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::List

inherited

Definition at line 57 of file Vector.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 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::Pointer torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::Pointer

inherited

Definition at line 58 of file Vector.hpp.

typedef BaseType::SizeType torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::SizeType

inherited

Definition at line 59 of file Vector.hpp.

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

inherited

Definition at line 62 of file Composite.hpp.

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

inherited

Definition at line 50 of file Composite.hpp.

typedef BaseType::Type torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::Type

inherited

Definition at line 56 of file Vector.hpp.

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

Definition at line 101 of file InstanceArray.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::InstanceArray::~InstanceArray	(	)
throw	(
	)

virtual

Definition at line 161 of file InstanceArray.cpp.

161 {}

torc::generic::InstanceArray::InstanceArray ( )

protected

Definition at line 158 of file InstanceArray.cpp.

158 : Instance(), Vector<Instance, InstanceArrayMember,

159 InstanceArrayMember::Factory, false>() {}

torc::generic::InstanceArrayMember::Factory

FactoryType< InstanceArrayMember > Factory

Definition: InstanceArrayMember.hpp:50

torc::generic::Vector< Instance, InstanceArrayMember, InstanceArrayMember::Factory, false >::Vector

Vector()

torc::generic::Instance::Instance

Instance()

Definition: generic/Instance.cpp:260

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 96 of file InstanceArray.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::InstanceArray::addPortReference	(	const PortReferenceSharedPtr &	inPortRef	)
throw	(	Error
	)

virtual

Add a port reference to this master.

Parameters

[in] inPortRef A port reference.

Exceptions

Error The method is unsupoorted for this class.

Reimplemented from torc::generic::Instance.

Definition at line 131 of file InstanceArray.cpp.

                                                                                           {
     //TBD::ERROR UNSUPPORTED
 }

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::InstanceArray::applyOnAllBits	(	const _Action &	action	)
throw	(	Error
	)

inline

Apply action on all bits of the array.

Parameters

[in] action Action to be applied

Apply action on all bits.

Parameters

[in] action Action to be applied

Definition at line 178 of file InstanceArray.hpp.

                   {
     try {
         std::vector<InstanceSharedPtr> children;
         getChildren(children);
         std::for_each(children.begin(), children.end(), action);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

void torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::applyOnAllChildren	(	const _Action &	action	)
throw	(	Error
	)

inherited

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::InstanceArray::bindToMasterView	(	const ViewSharedPtr &	inMaster,
		bool	inMapPortReferences = `true`
	)
throw	(	Error
	)

virtual

Reimplemented from torc::generic::Instance.

Definition at line 113 of file InstanceArray.cpp.

                   {
     typedef std::vector<InstanceSharedPtr> Children;
     Children children;
     getChildren(children);
     Children::iterator child = children.begin();
     Children::iterator cEnd = children.end();
     for(; child != cEnd; ++child) {
         try {
             (*child)->bindToMasterView(inMaster);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
     Instance::bindToMasterView(inMaster, false);
 }

Here is the call graph for this function:

void torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::constructChildren	(	const boost::shared_ptr< ChildFactory > &	inFactory,
		const std::vector< SizeType > &	inLimits
	)
throw	(	Error
	)

inlineinherited

Create list of children using the provided factory and limits

Parameters

[in]	inFactory	ChildFactory to use for construcing children
[in]	inLimits	Array dimensions

Exceptions

Error Children could not be created

Note: setName() must have already been called before calling this method. For preserved arrays this does not actually do anything other than storing the factory and limits inside itself for later use.

Create list of children using the provided factory and limits

Parameters

[in]	inFactory	ChildFactory to use for construcing children
[in]	inLimits	Array dimensions

Exceptions

Error Children could not be created

Note: For preserved arrays this does not actually do anything other than storing the factory and limits inside itself for later use.

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::InstanceArray::findPortReference	(	const std::string &	inPortRef	)
throw	(	Error
	)

virtual

Find a port reference.

Parameters

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

Exceptions

Error The method is unsupoorted for this class.

Reimplemented from torc::generic::Instance.

Definition at line 135 of file InstanceArray.cpp.

                                                                                              {
     //TBD::ERROR UNSUPPORTED
     return PortReferenceSharedPtr();
 }

virtual void torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::forceAutoBlast	(	void	)
throw	(	Error
	)

virtualinherited

Force creation of VectorBit children, even if this is a preserved Vector.

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

virtual const Pointer torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::get	(	const std::vector< SizeType > &	inIndices	)	const
throw	(	Error
	)

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 Id : eMessageIdErrorArrayIndexSizeMismatch Context Data Array Index Size - size_t Array Dimension Size - size_t
Error	Array index out of bounds Id : eMessageIdErrorArrayIndexOutOfBounds Context Data Array Index - size_t Array Dimension - size_t
Error	Empty Array Id : eMessageIdErrorEmptyArray Context Data Array Dimension - size_t

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

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

virtual void torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::getChildren	(	List &	outChildren	)	const
throw	(	Error
	)

virtualinherited

Get children of this composition.

Parameters

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

Exceptions

Error If factory is not set and preserve is true and the vector has not been blasted, an exception is generated.

Implements torc::generic::Composite< 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::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 >.

virtual CompositionType torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::getCompositionType ( ) const

virtualinherited

Get composition type for this object

Returns: The CompositionType inSource eCompositionTypeVector is returned

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

virtual void torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::getCreatedChildren	(	List &	outChildren	)	const
throw	(	Error
	)

virtualinherited

Here is the caller graph for this function:

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 boost::shared_ptr<ChildFactory> torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::getFactory ( ) const

inlineprotectedinherited

Get current factory

Returns: Return ChildFactory object

Exceptions

Error

Null Child Factory

Id : eMessageIdErrorNullChildfactory
Context Data
- Child factory - ChildFactory
Get current factory

Returns: Return ChildFactory object

bool torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::getIsPreserved ( ) const

inlineinherited

void torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::getLimits ( std::vector< SizeType > & outLimits ) const

inlineinherited

Get dimensions of the array.

Parameters

[in] outLimits Dimensions of the vector

Get dimensions of the array.

Returns: Dimensions of the vector

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

virtualinherited

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

Reimplemented in torc::generic::InstanceArrayMember.

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

                                                      {
     return mMyContext;
 }

Here is the caller graph for this function:

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

virtualinherited

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

Returns: A ParameterMap consisting of only the overridden parameters.

Reimplemented in torc::generic::InstanceArrayMember.

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

                                                                   {
     if(!getMaster()) {
         return ParameterMapSharedPtr();
     }
     ParameterMapSharedPtr params = mMaster->getParameters();
     if(!params->isContextRegistered(mMyContext)) {
         params->registerContext(mMyContext, mMaster->getParameterContext());
     }
     return params;
 }

Here is the call graph for this function:

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< 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::InstanceArray::getPortReferences ( std::vector< PortReferenceSharedPtr > & outPortRefs ) const

virtual

Get list of all port references.

Returns: List of port references

Reimplemented from torc::generic::Instance.

Definition at line 144 of file InstanceArray.cpp.

                                                                                           {
     return;
 }

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

virtual SizeType torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::getSize ( void ) const

virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

Implements torc::generic::Composite< 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;
 }

virtual void torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::onAutoBlast	(		)	const
throw	(	Error
	)

protectedvirtualinherited

void torc::generic::InstanceArray::onChildCreate	(	const boost::shared_ptr< BaseVectorType::ChildType > &	inCreatedChild	)	const
throw	(	Error
	)

protectedvirtual

Definition at line 153 of file InstanceArray.cpp.

                                         {
     inCreatedChild->setName(getName());
 }

virtual void torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::onChildCreate	(	const boost::shared_ptr< ChildType > &	inCreatedChild	)	const
throw	(	Error
	)

protectedvirtualinherited

void torc::generic::InstanceArray::removePortReference	(	const std::string &	inName	)
throw	(	Error
	)

virtual

Remove a given port reference.

Parameters

inName Name of the object to be delete

Exceptions

Error The method is unsupoorted for this class.

Reimplemented from torc::generic::Instance.

Definition at line 140 of file InstanceArray.cpp.

                                                                              {
     //TBD::ERROR UNSUPPORTED
 }

void torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::setChildren	(	const List &	inSource	)
throw	(	Error
	)

protectedinherited

Set list of children for unpreserved vector.

Parameters

[in] inSource List of children

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::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::setFactory ( const boost::shared_ptr< ChildFactory > & inSource )

protectedinherited

Set current factory

Parameters

[in] inSource ChildFactory object

void torc::generic::Vector< Instance , InstanceArrayMember , InstanceArrayMember::Factory , cPreserve >::setLimits ( const std::vector< SizeType > & inSource )

protectedinherited

Set dimensions of the array.

Parameters

[in] inSource Dimensions of the vector

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:

void torc::generic::InstanceArray::setParent ( const ViewSharedPtr & inParent )

virtual

Definition at line 105 of file InstanceArray.cpp.

                                                            {
     ParentedObject<View>::setParent(inParent);
     BaseVectorType::List children;
     getCreatedChildren(children);
     std::for_each(children.begin(), children.end(),
         boost::bind(boost::mem_fn(&Instance::setParent), _1, getParent()));
 }

Here is the call 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::InstanceArray::setPortReferences	(	const std::vector< PortReferenceSharedPtr > &	inSource	)
throw	(	Error
	)

virtual

Set list of all port references.

Parameters

[in] inSource List of port references

Exceptions

Error The method is unsupoorted for this class.

Reimplemented from torc::generic::Instance.

Definition at line 148 of file InstanceArray.cpp.

                   {
     //TBD::ERROR UNSUPPORTED
 }

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

Friends And Related Function Documentation

friend class FactoryType< InstanceArray >

friend

Definition at line 52 of file InstanceArray.hpp.

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

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation