torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve > Class Template Reference

An array of objects. More...

#include <Vector.hpp>

Inheritance diagram for torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >:

Collaboration diagram for torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >:

Public Types
typedef Composite< _Type >	BaseType
typedef BaseType::Type	Type
typedef BaseType::List	List
typedef BaseType::Pointer	Pointer
typedef BaseType::SizeType	SizeType
typedef _ChildType	ChildType
typedef boost::shared_ptr < ChildType >	ChildPointer
typedef _ChildFactoryType	ChildFactory
typedef boost::shared_ptr < _ChildFactoryType >	ChildFactorySharedPtr
typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual	~Vector () throw ()
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)
template<typename _Action >
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
virtual void	setParentCollection (const Pointer &inParentCollection)
virtual Pointer	getParentCollection () const
void	setWeakThis (const WeakPointer &inWeakThis)
Pointer	getSharedThis () const

Protected Member Functions
	Vector ()
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)

Private Types
typedef SymTab< SizeType, Pointer >	SparseElements

Private Member Functions
void	autoBlast () const throw (Error)
void	incrementIndices (std::vector< SizeType > &indices, const std::vector< SizeType > &limits) const
SizeType	indicesToAbsoluteIndex (const std::vector< SizeType > &inIndices) const
SizeType	storageSize () const
	Vector (const Vector< _Type, _ChildType, _ChildFactoryType, cPreserve > &source)
Vector< _Type, _ChildType, _ChildFactoryType, cPreserve > &	operator= (const Vector< _Type, _ChildType, _ChildFactoryType, cPreserve > &source)

Private Attributes
std::vector< SizeType >	mLimits
List	mChildren
SparseElements	mSparseElements
boost::shared_ptr< ChildFactory >	mFactory
bool	mIsPreserved
SizeType	mPreservationThreshold

Detailed Description

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>
class torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >

An array of objects.

This provides methods for accessing and adding elements to the array. It also implements the VectorPreservation algorithm if cPreserve is set to true. The vector class creates elements derived from VectorBit class by using the provided factory.

Definition at line 50 of file Vector.hpp.

Member Typedef Documentation

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

typedef Composite<_Type> torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::BaseType

Definition at line 55 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

typedef _ChildFactoryType torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::ChildFactory

Definition at line 62 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

typedef boost::shared_ptr<_ChildFactoryType> torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::ChildFactorySharedPtr

Definition at line 63 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

typedef boost::shared_ptr<ChildType> torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::ChildPointer

Definition at line 61 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

typedef _ChildType torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::ChildType

Definition at line 60 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

typedef BaseType::List torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::List

Definition at line 57 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

typedef BaseType::Pointer torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::Pointer

Definition at line 58 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

typedef BaseType::SizeType torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::SizeType

Definition at line 59 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

typedef SymTab<SizeType, Pointer> torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::SparseElements

private

Definition at line 66 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

typedef BaseType::Type torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::Type

Definition at line 56 of file Vector.hpp.

template<typename _Type>

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

inherited

Definition at line 56 of file Composite.hpp.

Constructor & Destructor Documentation

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::Vector ( )

protected

Definition at line 292 of file Vector.hpp.

                                                             : BaseType(), mLimits(),
    mChildren(), mFactory(), mIsPreserved(cPreserve), mPreservationThreshold(1024) {}

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::~Vector ( ) throw ( )

virtual

Definition at line 289 of file Vector.hpp.

{}

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::Vector ( const Vector< _Type, _ChildType, _ChildFactoryType, cPreserve > &  source )

private

Member Function Documentation

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

template<typename _Action >

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::applyOnAllChildren	(	const _Action &	action	)
throw	(	Error
	)

Definition at line 448 of file Vector.hpp.

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

}

Here is the call graph for this function:

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::autoBlast ( ) const throw ( Error )

inlineprivate

Definition at line 534 of file Vector.hpp.

                                                                                                {
    SizeType size = storageSize();
    mChildren.resize(mChildren.size() + size); //create empty
    Pointer thisPtr = BaseType::getSharedThis();
    std::vector < SizeType > indices(mLimits.size());
    fill(indices.begin(), indices.end(), 0);
    if(!thisPtr) {
        Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Pointer to this object does not exist", thisPtr);
        throw e;
    }
    boost::shared_ptr < ChildFactory > factory = getFactory();
    if(!factory) {
        Error e(eMessageIdErrorNullChildfactory, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Null Child Factory", factory);
        throw e;
    }
    for(SizeType index = 0; index < size; index++) {
        Pointer child;
        bool createNew = (cPreserve && mSparseElements.getSize() > 0
            && mSparseElements.get(index, child)) ? false : true;
        if(createNew) {
            ChildPointer newChild;
            try {
                factory->create(newChild);
                newChild->setParentCollection(thisPtr);
                newChild->setIndices(indices);
                newChild->setAbsoluteIndex(index);
                child = newChild;
                onChildCreate(newChild);
            } catch(Error& e) {
                mChildren.clear(); //For consistency
                e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
                throw;
            }
        }
        incrementIndices(indices, mLimits);
        mChildren[index] = child;
    }
    mSparseElements.clear();
    try {
        onAutoBlast();
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

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

inline

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.

Definition at line 502 of file Vector.hpp.

                      {
    if(inLimits.empty()) {
        Error e(eMessageIdErrorEmptyArray, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Empty Array,", inLimits.empty());
        throw e;
    } else {
        typename std::vector<SizeType>::const_iterator index = inLimits.begin();
        typename std::vector<SizeType>::const_iterator lend = inLimits.end();
        for(; index != lend; index++) {
            if(*index == 0) {
                Error e(eMessageIdErrorEmptyArray, __FUNCTION__, __FILE__, __LINE__);
                e.saveContextData("Empty Array,", *index);
                throw e;
            }
        }
    }

    setFactory(inFactory);
    setLimits(inLimits);
    if(!cPreserve) {
        try {
            autoBlast();
        } catch(Error& e) {
            e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
            throw;
        }
    }
}

Here is the call graph for this function:

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::forceAutoBlast ( void  ) throw ( Error )

inlinevirtual

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

Definition at line 479 of file Vector.hpp.

                      {
    if(!mFactory) return;
    if(mLimits.empty()) return;
    try {
        autoBlast();
    } 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:

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

const Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::Pointer torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::get ( const std::vector< SizeType > &  inIndices ) const throw ( Error )

virtual

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

Definition at line 363 of file Vector.hpp.

                                   {
    if(inIndices.size() != mLimits.size()) {
        Error e(eMessageIdErrorArrayIndexSizeMismatch, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Array Index", inIndices.size());
        e.saveContextData("Array Dimension", mLimits.size());
        throw e;
    } else {
        typename std::vector<SizeType>::const_iterator lend = mLimits.end();
        typename std::vector<SizeType>::const_iterator limit = mLimits.begin();
        typename std::vector<SizeType>::const_iterator index = inIndices.begin();
        for(; limit != lend; ++limit, ++index) {
            if(*index >= *limit) {
                Error e(eMessageIdErrorArrayIndexOutOfBounds, __FUNCTION__, __FILE__, __LINE__);
                e.saveContextData("Array Index", *index);
                e.saveContextData("Array Dimension", *limit);
                throw e;
            }
        }
    }

    SizeType index = indicesToAbsoluteIndex(inIndices);

    Pointer thisPtr = BaseType::getSharedThis();
    boost::shared_ptr < ChildFactory > factory = getFactory();
    if(!factory) {
        Error e(eMessageIdErrorNullChildfactory, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Null Child Factory", factory);
        throw e;
    }

    Pointer child;
    if(cPreserve && mChildren.empty()) {
        if(false == mSparseElements.get(index, child)) {
            ChildPointer newChild;
            try {
                factory->create(newChild);
                newChild->setParentCollection(thisPtr);
                newChild->setIndices(inIndices);
                newChild->setAbsoluteIndex(index);
                mSparseElements.set(index, newChild);
                child = newChild;
                onChildCreate(newChild);
            } catch(Error& e) {
                e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
                throw;
            }
        }
        //TBD::THRESHOLD BASED CHECKING?
    } else {
        child = mChildren[index];
    }

    return child;
}

Here is the call graph for this function:

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::getChildren ( List &  outChildren ) const throw ( Error )

virtual

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

Definition at line 428 of file Vector.hpp.

                  {
    if(cPreserve //Is the vector preserved? Otherwise it already has all the elements
    && !mLimits.empty() //Do we have sufficient info to blast
    && mChildren.empty()) //Haven't we already blasted
        {
        try {
            autoBlast();
        } catch(Error& e) {
            e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
            throw;
        }
    }
    outChildren.insert(outChildren.end(), mChildren.begin(), mChildren.end());
    return;
}

Here is the call graph for this function:

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

CompositionType torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::getCompositionType ( ) const

virtual

Get composition type for this object

Returns

The CompositionType inSource eCompositionTypeVector is returned

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

Definition at line 301 of file Vector.hpp.

          {
    return eCompositionTypeVector;
}

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::getCreatedChildren ( List &  outChildren ) const throw ( Error )

virtual

Definition at line 583 of file Vector.hpp.

                        {
    if(cPreserve && mChildren.empty()) {
        mSparseElements.getValues(outChildren);
    } else if(!mChildren.empty()) {
        try {
            getChildren(outChildren);
        } catch(Error& e) {
            e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
            throw;
        }
    }
    return;
}

Here is the call graph for this function:

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

const boost::shared_ptr< _ChildFactoryType > torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::getFactory ( ) const

inlineprotected

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

Definition at line 680 of file Vector.hpp.

                                 {
    return mFactory;
}

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

bool torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::getIsPreserved ( ) const

inline

Definition at line 658 of file Vector.hpp.

                                                                                       {
    return mIsPreserved;
}

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::getLimits ( std::vector< SizeType > &  outLimits ) const

inline

Get dimensions of the array.

Parameters

[in]

outLimits

Dimensions of the vector

Get dimensions of the array.

Returns

Dimensions of the vector

Definition at line 652 of file Vector.hpp.

                                          {
    outLimits.insert(outLimits.end(), mLimits.begin(), mLimits.end());
}

template<typename _Type >

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

inlinevirtualinherited

Get a pointer to the parent collection

Returns

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

Definition at line 156 of file Composite.hpp.

                                                {
    return mParentCollection.lock();
}

Pointer torc::generic::SelfReferencing< _Type >::getSharedThis ( ) const

inlineinherited

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Returns

A shared pointer to this object

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Parameters

[out]

ptr

Set to a shared pointer to this object

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::SizeType torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::getSize ( void  ) const

virtual

Get the total number of bits of the composition

Returns

Number of bits

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

Definition at line 312 of file Vector.hpp.

                                                             {
    return storageSize();
}

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::incrementIndices ( std::vector< SizeType > &  indices, const std::vector< SizeType > &  limits  ) const

private

Definition at line 605 of file Vector.hpp.

                                                                           {
    SizeType size = limits.size();
    bool incr = false;
    for(SizeType i = 0; i < size; i++) {
        if(i == 0 || incr) {
            ++indices[i];
            if(indices[i] == limits[i]) {
                indices[i] = 0;
                incr = true;
            } else {
                incr = false;
            }
        }
    }
}

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::SizeType torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::indicesToAbsoluteIndex ( const std::vector< SizeType > &  inIndices ) const

inlineprivate

Definition at line 624 of file Vector.hpp.

                                                {
    SizeType idx = 0;
    SizeType size = mLimits.size();
    for(SizeType k = 1; k <= size; k++) {
        SizeType prod = 1;
        for(SizeType l = k + 1; l <= size; l++) {
            prod *= mLimits[l - 1];
        }
        idx += prod * inIndices[k - 1];
    }
    return idx;
}

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::onAutoBlast ( ) const throw ( Error )

protectedvirtual

Definition at line 470 of file Vector.hpp.

                                                                                             {
    //Do nothing here
    //meant to be overridden by clients
}

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::onChildCreate ( const boost::shared_ptr< ChildType > &  inCreatedChild ) const throw ( Error )

protectedvirtual

Definition at line 599 of file Vector.hpp.

                                                                          {
    //If required, inherited classes will override this
}

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

Vector<_Type, _ChildType, _ChildFactoryType, cPreserve>& torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::operator= ( const Vector< _Type, _ChildType, _ChildFactoryType, cPreserve > &  source )

private

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::setChildren ( const List &  inSource ) throw ( Error )

protected

Set list of children for unpreserved vector.

Parameters

[in]

inSource

List of children

Definition at line 464 of file Vector.hpp.

                            {
    mChildren = inSource;
}

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::setFactory ( const boost::shared_ptr< ChildFactory > &  inSource )

protected

Set current factory

Parameters

[in]

inSource

ChildFactory object

Definition at line 690 of file Vector.hpp.

                                                         {
    mFactory = inSource;
}

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

void torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::setLimits ( const std::vector< SizeType > &  inSource )

protected

Set dimensions of the array.

Parameters

[in]

inSource

Dimensions of the vector

Definition at line 668 of file Vector.hpp.

                                         {
    mLimits = inSource;
}

template<typename _Type>

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

inlinevirtualinherited

Set a pointer to a parnt composition.

Parameters

[in]

inParentCollection

pointer to the parent collection (Vector/Bundle)

Set a pointer to a parnt composition.

Parameters

[in]

parentCollection

pointer to the parent collection (Vector/Bundle)

Definition at line 145 of file Composite.hpp.

                                                                {
    mParentCollection = inParentCollection;
}

void torc::generic::SelfReferencing< _Type >::setWeakThis ( const WeakPointer &  inWeakThis )

inlineinherited

Set a weak pointer to this object. This will be used later to get a shared pointer to this object from within other member methods if required. This should be called by the Factory creating the object.

Parameters

[in]

weakThis

A weak pointer to this object

template<typename _Type , typename _ChildType , typename _ChildFactoryType , bool cPreserve>

Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::SizeType torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::storageSize ( ) const

inlineprivate

Definition at line 640 of file Vector.hpp.

                                                                               {
    return std::accumulate(mLimits.begin(), mLimits.end(), 1,
        std::multiplies<typename Vector<_Type, _ChildType, _ChildFactoryType,
        cPreserve>::SizeType>());
}

Field Documentation

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

List torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::mChildren

mutableprivate

Definition at line 275 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

boost::shared_ptr<ChildFactory> torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::mFactory

private

Definition at line 277 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

bool torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::mIsPreserved

private

Definition at line 278 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

std::vector<SizeType> torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::mLimits

private

Definition at line 274 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

SizeType torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::mPreservationThreshold

private

Definition at line 279 of file Vector.hpp.

template<typename _Type, typename _ChildType, typename _ChildFactoryType, bool cPreserve = false>

SparseElements torc::generic::Vector< _Type, _ChildType, _ChildFactoryType, cPreserve >::mSparseElements

mutableprivate

Definition at line 276 of file Vector.hpp.

---

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

• Vector.hpp