torc::generic::SingleParameter::Factory Class Reference

#include <SingleParameter.hpp>

Inheritance diagram for torc::generic::SingleParameter::Factory:

Collaboration diagram for torc::generic::SingleParameter::Factory:

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

Public Member Functions
virtual SingleParameterSharedPtr	newSingleParameterPtr (const std::string &inName, const Value &inValue, const Unit &inUnit=eUnitUndefined, const std::string &inOriginalName=std::string()) throw (Error)
virtual void	create (Pointer &outPointer) throw (Error)

Detailed Description

Convenience class to create a single parameter.

Definition at line 51 of file SingleParameter.hpp.

Member Typedef Documentation

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

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

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

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

typedef SelfReferencing<Type>::WeakPointer torc::generic::FactoryType< SingleParameter >::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< SingleParameter >::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
        }
    }

SingleParameterSharedPtr torc::generic::SingleParameter::Factory::newSingleParameterPtr ( const std::string &  inName, const Value &  inValue, const Unit &  inUnit = eUnitUndefined, const std::string &  inOriginalName = std::string()  ) throw ( Error )

virtual

Create a single parameter.

Parameters

[in]	inName	Name of the single parameter to be created.
[in]	inValue	Value of the parameter.
[in]	inUnit	Unit of the parameter.
[in]	inOriginalName	Original name of the single parameter [optional].

Returns

Pointer to created single parameter.

Create a single parameter.

Parameters

[in]	inName	Name of the single parameter to be created.
[in]	inValue	Value of the parameter.
[in]	inUnit	Unit of the parameter.

Returns

Pointer to created single parameter.

Definition at line 41 of file SingleParameter.cpp.

                                                                                             {
    try {
        SingleParameterSharedPtr newSingleParameter;
        create(newSingleParameter);
        newSingleParameter->setName(inName);
        newSingleParameter->setValue(inValue);
        newSingleParameter->setUnit(inUnit);
        newSingleParameter->setOriginalName(inOriginalName);
        return newSingleParameter;
    } 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:

• SingleParameter.hpp
• SingleParameter.cpp