OBT::ServiceManager Class Reference

Plugins can add services to the ServiceManager, these services can later be used without knowing their implementation. More...

#include <OBTServiceManager.h>

Collaboration diagram for OBT::ServiceManager:

[legend]

List of all members.

Private Types
typedef std::map < std::string, std::map< unsigned int, IService * > >	ServicesMap
	Registered services.
Private Member Functions
	ServiceManager ()
	ServiceManager (const ServiceManager &)
virtual	~ServiceManager ()
const ServiceManager &	operator= (const ServiceManager &)
Private Attributes
ServicesMap	_services
Friends
class	Singleton< ServiceManager >
template<class TService>
TService *	getService (unsigned int ID=0)
	Get a service.
template<class TService>
const std::map < unsigned int, IService * > *	getServices ()
template<class TService>
void	addService (TService *service, unsigned int ID=0)
template<class TService>
void	removeService (unsigned int ID=0)

---

Detailed Description

Plugins can add services to the ServiceManager, these services can later be used without knowing their implementation.

Author:

Michaël Rouillé <michael.rouille@gmail.com>

Loaded plugins can add services the ServiceManager. One service interface may be realized by several implementation classes. A user of this service can then choose between these implementations, according to a specific criterion (e.g file extension for a loader). Services have to be queried via a call to ServiceManager

Definition at line 22 of file OBTServiceManager.h.

---

Member Typedef Documentation

typedef std::map< std::string, std::map< unsigned int, IService* > > OBT::ServiceManager::ServicesMap [private]

Registered services.

Definition at line 74 of file OBTServiceManager.h.

---

Constructor & Destructor Documentation

ServiceManager::ServiceManager

(

)

[private]

constructor

Definition at line 8 of file OBTServiceManager.cpp.

{
}

OBT::ServiceManager::ServiceManager

(

const ServiceManager &

)

[private]

copy constructor

ServiceManager::~ServiceManager

(

)

[private, virtual]

destructor

Definition at line 15 of file OBTServiceManager.cpp.

{
}

---

Member Function Documentation

const ServiceManager& OBT::ServiceManager::operator=

(

const ServiceManager &

)

[private]

assignment

---

Friends And Related Function Documentation

friend class Singleton< ServiceManager > [friend]

Definition at line 24 of file OBTServiceManager.h.

template<class TService>

TService* getService

(

unsigned int

ID = 0

)

[friend]

Get a service.

Parameters:

	TService	type of the service to get.
	ID	id of the service to get.

Returns:

the service if found, NULL otherwise.

Definition at line 85 of file OBTServiceManager.h.

        {
                ServiceManager::ServicesMap& services( Singleton< ServiceManager >::getInstance()._services ) ;
                ServiceManager::ServicesMap::iterator servicesIte( services.find( typeid( TService ).name() ) ) ;
                if ( servicesIte != services.end() )
                {
                        std::map< unsigned int, IService* >::iterator ite( servicesIte->second.find( ID ) ) ;
                        if ( ite != servicesIte->second.end() )
                        {
                                return static_cast<TService*>( ite->second ) ;
                        }
                }
                TRACE_WARNING( "The following service was not found : " << typeid( TService ).name() << " with id " << ID ) ;
                return NULL ;
        }

template<class TService>

const std::map< unsigned int, IService* >* getServices

(

)

[friend]

Get all the services of the given type.

Parameters:

TService

type of the services to get.

Returns:

the service if found, NULL otherwise.

Definition at line 105 of file OBTServiceManager.h.

        {
                const std::map< unsigned int, IService* >* servicesFound = 0 ;
                ServiceManager::ServicesMap& services( Singleton< ServiceManager >::getInstance()._services ) ;
                ServiceManager::ServicesMap::const_iterator servicesIte( services.find( typeid( TService ).name() ) ) ;
                if ( servicesIte != services.end() )
                {
                        servicesFound = &servicesIte->second ;
                }
                else
                {
                        TRACE_WARNING( "The following services was not found : " << typeid( TService ).name() ) ;
                }
                return servicesFound ;
        }

template<class TService>

void addService	(	TService *	service,
		unsigned int	ID = 0
	)			[friend]

Add a service

Parameters:

service

to add.

Exceptions:

[DEBUG

ONLY] if service is null

Definition at line 125 of file OBTServiceManager.h.

        {
                OBT_DBG_ASSERT( service != NULL ) ;
                ServiceManager::ServicesMap::mapped_type& serviceMap
                        ( Singleton< ServiceManager >::getInstance()._services[ typeid( TService ).name() ] ) ;
                serviceMap[ ID ] = service ;
        }

template<class TService>

void removeService

(

unsigned int

ID = 0

)

[friend]

Remove a service

Exceptions:

[DEBUG

ONLY] if service is null

Definition at line 137 of file OBTServiceManager.h.

        {
                ServiceManager::ServicesMap::iterator servicesIte
                        ( Singleton< ServiceManager >::getInstance()._services.find( typeid( TService ).name() ) ) ;
                if ( servicesIte != Singleton< ServiceManager >::getInstance()._services.end() )
                {
                        std::map< unsigned int, IService* >::iterator ite( servicesIte->second.find( ID ) ) ;
                        if ( ite != servicesIte->second.end() )
                        {
                                servicesIte->second.erase( ite ) ;
                                if ( servicesIte->second.empty() )
                                {
                                        Singleton< ServiceManager >::getInstance()._services.erase( servicesIte ) ;
                                }
                        }
                }
        }

---

Member Data Documentation

ServicesMap OBT::ServiceManager::_services [private]

Definition at line 76 of file OBTServiceManager.h.

---