torc::generic::WaveValue::Factory Class Reference

#include <WaveValue.hpp>

Inheritance diagram for torc::generic::WaveValue::Factory:

Collaboration diagram for torc::generic::WaveValue::Factory:

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

Public Member Functions
virtual WaveValueSharedPtr	newWaveValuePtr (const std::string &inName, const Value &inDeltaTimeDuration, const LogicElementSharedPtr inLogicWaveForm, const SimulateSharedPtr &inSimulate=SimulateSharedPtr()) throw (Error)
virtual void	create (Pointer &outPointer) throw (Error)

Detailed Description

Convenience class to create a WaveValue.

Definition at line 50 of file WaveValue.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
        }
    }

WaveValueSharedPtr torc::generic::WaveValue::Factory::newWaveValuePtr ( const std::string &  inName, const Value &  inDeltaTimeDuration, const LogicElementSharedPtr  inLogicWaveForm, const SimulateSharedPtr &  inSimulate = SimulateSharedPtr()  ) throw ( Error )

virtual

Create a WaveValue.

Parameters

[in]	inName	Name of the WaveValue to be created.
[in]	inDeltaTimeDuration	Value Delta time duration between the values contained in the logic waveform.
[in]	inLogicWaveForm	Logic wave form for this WaveValue.
[in]	inSimulate	Pointer to parented (Simulate) object [optional]. If not mentioned WaveValue will not be added to simulate.

Returns

Pointer to created WaveValue.

Definition at line 35 of file WaveValue.cpp.

                                                       {
    try {
        WaveValueSharedPtr newWaveValue;
        create(newWaveValue);
        newWaveValue->setName(inName);
        newWaveValue->setDeltaTimeDuration(inDeltaTimeDuration);
        newWaveValue->setLogicWaveform(inLogicWaveForm);
        if(inSimulate) {
            inSimulate->addWaveValue(newWaveValue);
        }
        return newWaveValue;
    } 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:

• WaveValue.hpp
• WaveValue.cpp