torc::generic::ParameterArray::Factory Class Reference

#include <ParameterArray.hpp>

Inheritance diagram for torc::generic::ParameterArray::Factory:

Collaboration diagram for torc::generic::ParameterArray::Factory:

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

Public Member Functions
virtual ParameterArraySharedPtr	newParameterArrayPtr (const std::string &inName, const size_t &inSize, const ChildFactorySharedPtr &inFactory=BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &inOriginalName=std::string()) throw (Error)
virtual ParameterArraySharedPtr	newParameterArrayPtr (const std::string &inName, 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 a parameter array.

Definition at line 57 of file ParameterArray.hpp.

Member Typedef Documentation

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

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

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

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

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

inherited

A weak pointer to an object of type Type

Definition at line 50 of file FactoryType.hpp.

Member Function Documentation

virtual void torc::generic::FactoryType< ParameterArray >::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
        }
    }

ParameterArraySharedPtr torc::generic::ParameterArray::Factory::newParameterArrayPtr ( const std::string &  inName, const size_t &  inSize, const ChildFactorySharedPtr &  inFactory = BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &  inOriginalName = std::string()  ) throw ( Error )

virtual

Create a parameter array.

Parameters

[in]	inName	Name of the parameter array to be created.
[in]	inSize	Size of the instance array.
[in]	inFactory	Factory for the child.
[in]	inOriginalName	Original name of the parameter array [optional].

Returns

Pointer to created parameter array.

Create a parameter array.

Parameters

[in]	inName	Name of the parameter array to be created.
[in]	inUnit	Unit of the parameter array.
[in]	inFactory	Factory for the child.
[in]	inOriginalName	Original name of the parameter array [optional].

Returns

Pointer to created parameter array.

Definition at line 55 of file ParameterArray.cpp.

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

Here is the call graph for this function:

ParameterArraySharedPtr torc::generic::ParameterArray::Factory::newParameterArrayPtr ( const std::string &  inName, const std::vector< size_t > &  inLimits, const ChildFactorySharedPtr &  inFactory = BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &  inOriginalName = std::string()  ) throw ( Error )

virtual

Create a parameter array.

Parameters

[in]	inName	Name of the parameter array to be created.
[in]	inLimits	Dimensions of the vector.
[in]	inFactory	Factory for the child.
[in]	inOriginalName	Original name of the parameter array [optional].

Returns

Pointer to created parameter array.

Create a parameter array.

Parameters

[in]	inName	Name of the parameter array to be created.
[in]	inLimits	Dimensions of the vector.
[in]	inValue	Value of the parameter array.
[in]	inUnit	Unit of the parameter array.
[in]	inFactory	Factory for the child.
[in]	inOriginalName	Original name of the parameter array [optional].

Returns

Pointer to created parameter array.

Definition at line 80 of file ParameterArray.cpp.

                                                   {
    try {
        ParameterArraySharedPtr newParameterArray;
        create(newParameterArray);
        newParameterArray->setName(inName);
        newParameterArray->setOriginalName(inOriginalName);
        newParameterArray->constructChildren(inFactory, inLimits);
        return newParameterArray;
    } 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:

• ParameterArray.hpp
• ParameterArray.cpp