torc::generic::InstanceArray::Factory Class Reference

#include <InstanceArray.hpp>

Inheritance diagram for torc::generic::InstanceArray::Factory:

Collaboration diagram for torc::generic::InstanceArray::Factory:

Public Types
typedef _Tp	Type
typedef SelfReferencing< Type > ::Pointer	Pointer
typedef SelfReferencing< Type > ::WeakPointer	WeakPointer

Public Member Functions
virtual InstanceArraySharedPtr	newInstanceArrayPtr (const std::string &inName, const ViewSharedPtr &inViewPtr, const ViewSharedPtr &inMaster, const size_t &inSize, const ChildFactorySharedPtr &inFactory=BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &inOriginalName=std::string()) throw (Error)
virtual InstanceArraySharedPtr	newInstanceArrayPtr (const std::string &inName, const ViewSharedPtr &inViewPtr, const ViewSharedPtr &inMaster, const std::vector< size_t > &inLimits, const ChildFactorySharedPtr &inFactory=BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &inOriginalName=std::string()) throw (Error)
virtual void	create (Pointer &outPointer) throw (Error)

Detailed Description

Convenience class to create an instance array.

Definition at line 61 of file InstanceArray.hpp.

Member Typedef Documentation

template<typename _Tp>

typedef SelfReferencing<Type>::Pointer torc::generic::FactoryType< _Tp >::Pointer

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

template<typename _Tp>

typedef _Tp torc::generic::FactoryType< _Tp >::Type

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

template<typename _Tp>

typedef SelfReferencing<Type>::WeakPointer torc::generic::FactoryType< _Tp >::WeakPointer

inherited

A weak pointer to an object of type Type

Definition at line 50 of file FactoryType.hpp.

Member Function Documentation

template<typename _Tp>

virtual void torc::generic::FactoryType< _Tp >::create ( Pointer &  outPointer ) throw ( Error )

inlinevirtualinherited

Create an object of the Type specification of Factory. If the object has a boost::weak_ptr to itself, it is the task of this method to set this after the object is created.

Returns

A pointer to the freshly created object.

Definition at line 58 of file FactoryType.hpp.

                                                           {
        try {
            Pointer temp(new _Tp()); //Do not remove
            outPointer = temp;
            WeakPointer weakPtr(outPointer);
            outPointer->setWeakThis(weakPtr);
        } catch(std::exception& e) //May receive std::bad_alloc
        {
            //TBD::ERROR
        }
    }

InstanceArraySharedPtr torc::generic::InstanceArray::Factory::newInstanceArrayPtr ( const std::string &  inName, const ViewSharedPtr &  inViewPtr, const ViewSharedPtr &  inMaster, const size_t &  inSize, const ChildFactorySharedPtr &  inFactory = BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &  inOriginalName = std::string()  ) throw ( Error )

virtual

Create an instance array

Parameters

[in]	inName	Name of the instance array to be created.
[in]	inViewPtr	Pointer to parented(view) object.
[in]	inMaster	Pointer to master object.
[in]	inSize	Size of the instance array.
[in]	inFactory	Factory for the child.
[in]	inOriginalName	Original name of the instance array [optional].

Returns

Pointer to created instance array.

Definition at line 51 of file InstanceArray.cpp.

                                                                                           {
    try {
        std::vector < size_t > limits;
        limits.push_back(inSize);
        return newInstanceArrayPtr(inName, inViewPtr, inMaster, limits, inFactory, inOriginalName);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

InstanceArraySharedPtr torc::generic::InstanceArray::Factory::newInstanceArrayPtr ( const std::string &  inName, const ViewSharedPtr &  inViewPtr, const ViewSharedPtr &  inMaster, const std::vector< size_t > &  inLimits, const ChildFactorySharedPtr &  inFactory = BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &  inOriginalName = std::string()  ) throw ( Error )

virtual

Create an instance array

Parameters

[in]	inName	Name of the instance array to be created.
[in]	inViewPtr	Pointer to parented(view) object.
[in]	inMaster	Pointer to master object.
[in]	inLimits	Dimensions of the vector.
[in]	inFactory	Factory for the child.
[in]	inOriginalName	Original name of the instance array [optional].

Returns

Pointer to created instance array.

Definition at line 77 of file InstanceArray.cpp.

                                                   {
    try {
        InstanceArraySharedPtr newInstanceArray;
        create(newInstanceArray);
        newInstanceArray->setName(inName);
        //newInstanceArray->setMaster(inMaster);
        newInstanceArray->constructChildren(inFactory, inLimits);
        newInstanceArray->bindToMasterView(inMaster);
        newInstanceArray->setOriginalName(inOriginalName);
        inViewPtr->addInstance(newInstanceArray);
        return newInstanceArray;
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

---

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

• InstanceArray.hpp
• InstanceArray.cpp