torc::generic::Written::Factory Class Reference

#include <Written.hpp>

Inheritance diagram for torc::generic::Written::Factory:

Collaboration diagram for torc::generic::Written::Factory:

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

Public Member Functions
virtual WrittenSharedPtr	newWrittenPtr (const TimeStamp &inTimeStamp, const StatusSharedPtr &inStatusPtr, const std::string &inAuthorName=std::string(), const std::string &inProgramName=std::string(), const std::string &inProgramVersion=std::string(), const std::string &inDataOriginLocName=std::string(), const std::string &inDataOriginVersion=std::string()) throw (Error)
virtual void	create (Pointer &outPointer) throw (Error)

Detailed Description

Convenience class to create a written.

Definition at line 43 of file Written.hpp.

Member Typedef Documentation

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

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

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

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

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

WrittenSharedPtr torc::generic::Written::Factory::newWrittenPtr ( const TimeStamp &  inTimeStamp, const StatusSharedPtr &  inStatusPtr, const std::string &  inAuthorName = std::string(), const std::string &  inProgramName = std::string(), const std::string &  inProgramVersion = std::string(), const std::string &  inDataOriginLocName = std::string(), const std::string &  inDataOriginVersion = std::string()  ) throw ( Error )

virtual

Create a written.

Parameters

[in]	inTimeStamp	TimeStamp in Universal Time Coordinate.
[in]	inStatusPtr	Pointer to parented(Status) object.
[in]	inAuthorName	Name of the author
[in]	inProgramName	Name of the program
[in]	inProgramVersion	Version of the program
[in]	inDataOriginLocName	Data Origin Location Name
[in]	inDataOriginVersion	Version of the DataOrigin

Returns

Pointer to created written.

Definition at line 35 of file Written.cpp.

                                                                                              {
    try {
        WrittenSharedPtr newWritten;
        create(newWritten);
        newWritten->setTimeStamp(inTimeStamp);
        newWritten->setAuthorName(inAuthorName);
        newWritten->setProgramName(inProgramName);
        newWritten->setProgramVersion(inProgramVersion);
        newWritten->setDataOriginLocationName(inDataOriginLocName);
        newWritten->setDataOriginVersion(inDataOriginVersion);
        if(inStatusPtr) {
            inStatusPtr->addWritten(newWritten);
        }
        return newWritten;
    } 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:

• Written.hpp
• Written.cpp