OPENTREP::FacPlaceHolder Class Reference

#include <opentrep/factory/FacPlaceHolder.hpp>

Inheritance diagram for OPENTREP::FacPlaceHolder:

Public Types
typedef std::vector < BomAbstract * >	BomPool_T

Public Member Functions
virtual	~FacPlaceHolder ()
PlaceHolder &	create ()

Static Public Member Functions
static FacPlaceHolder &	instance ()
static void	initLinkWithPlace (PlaceHolder &, Place &)
static std::size_t	getID (const BomAbstract *)
static std::size_t	getID (const BomAbstract &)
static std::string	getIDString (const BomAbstract *)
static std::string	getIDString (const BomAbstract &)

Protected Attributes
BomPool_T	_pool

Detailed Description

Factory for Place.

Definition at line 17 of file FacPlaceHolder.hpp.

Member Typedef Documentation

typedef std::vector<BomAbstract*> OPENTREP::FacBomAbstract::BomPool_T

inherited

Define the list (pool) of Bom objects.

Definition at line 22 of file FacBomAbstract.hpp.

Constructor & Destructor Documentation

OPENTREP::FacPlaceHolder::~FacPlaceHolder ( )

virtual

Destructor.
The Destruction put the _instance to NULL in order to be clean for the next FacPlaceHolder::instance()

Definition at line 26 of file FacPlaceHolder.cpp.

Member Function Documentation

FacPlaceHolder & OPENTREP::FacPlaceHolder::instance ( )

static

Provide the unique instance.
The singleton is instantiated when first used

Returns

FacPlaceHolder&

Definition at line 31 of file FacPlaceHolder.cpp.

References OPENTREP::FacSupervisor::instance(), and OPENTREP::FacSupervisor::registerBomFactory().

PlaceHolder & OPENTREP::FacPlaceHolder::create

(

)

Create a new PlaceHolder object.
This new object is added to the list of instantiated objects.

Returns

PlaceHolder& The newly created object.

Definition at line 43 of file FacPlaceHolder.cpp.

References OPENTREP::FacBomAbstract::_pool.

void OPENTREP::FacPlaceHolder::initLinkWithPlace ( PlaceHolder &  ioPlaceHolder, Place &  ioPlace  )

static

Initialise the link between a PlaceHolder and a Place.

Parameters

PlaceHolder&
Place&

Exceptions

FacExceptionNullPointer
FacException.

Definition at line 56 of file FacPlaceHolder.cpp.

References OPENTREP::Place::describeShortKey().

Referenced by OPENTREP::createPlaces().

std::size_t OPENTREP::FacBomAbstract::getID ( const BomAbstract *  iBomAbstract_ptr )

staticinherited

Return the ID corresponding to the given object pointer.

Definition at line 36 of file FacBomAbstract.cpp.

Referenced by OPENTREP::FacBomAbstract::getID(), and OPENTREP::FacBomAbstract::getIDString().

std::size_t OPENTREP::FacBomAbstract::getID ( const BomAbstract &  iBomAbstract )

staticinherited

Return the ID corresponding to the given object reference.

Definition at line 44 of file FacBomAbstract.cpp.

References OPENTREP::FacBomAbstract::getID().

std::string OPENTREP::FacBomAbstract::getIDString ( const BomAbstract *  iBomAbstract_ptr )

staticinherited

Return the ID, as a string, corresponding to the given object pointer.

Definition at line 49 of file FacBomAbstract.cpp.

References OPENTREP::FacBomAbstract::getID().

Referenced by OPENTREP::FacBomAbstract::getIDString().

std::string OPENTREP::FacBomAbstract::getIDString ( const BomAbstract &  iBomAbstract )

staticinherited

Return the ID, as a string, corresponding to the given object reference.

Definition at line 57 of file FacBomAbstract.cpp.

References OPENTREP::FacBomAbstract::getIDString().

Member Data Documentation

BomPool_T OPENTREP::FacBomAbstract::_pool

protectedinherited

List of instantiated Business Objects

Definition at line 53 of file FacBomAbstract.hpp.

Referenced by OPENTREP::FacWorld::clone(), OPENTREP::FacPlace::clone(), OPENTREP::FacWorld::create(), create(), OPENTREP::FacResultHolder::create(), OPENTREP::FacResult::create(), OPENTREP::FacPlace::create(), and OPENTREP::FacResultCombination::create().

---

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

• opentrep/factory/FacPlaceHolder.hpp
• opentrep/factory/FacPlaceHolder.cpp