rtctk::componentFramework::ServiceContainer Class Reference

Container class that holds services of any type. More...

#include <rtctk/componentFramework/serviceContainer.hpp>

Public Member Functions
	ServiceContainer ()=default
	ServiceContainer (const ServiceContainer &other)=delete
ServiceContainer &	operator= (const ServiceContainer &other)=delete
	ServiceContainer (const ServiceContainer &&other)=delete
ServiceContainer &	operator= (ServiceContainer &&other)=delete
	~ServiceContainer ()
template<typename Service >
void	Add (Service &&service, const std::string &name="")
	Insert new service into the container.
template<typename Service >
void	Add (std::shared_ptr< Service > service, const std::string &name="")
	Insert new service into the container.
template<typename Service >
Service &	Get (const std::string &name="")
	Get a handle to a service.
template<typename Service >
bool	Contains (const std::string &name="")
	Check if the service container holds a certain service.
std::vector< std::string >	List ()
	List currently available services.

Detailed Description

Container class that holds services of any type.

The class owns services which are identified by their type and name. Multiple services can be registered for a certain type. Users may request handles to these services.

Polymorphic services can be added as a specific type and retrieved as a generic type.

Constructor & Destructor Documentation

ServiceContainer() [1/3]

rtctk::componentFramework::ServiceContainer::ServiceContainer ( )

default

ServiceContainer() [2/3]

rtctk::componentFramework::ServiceContainer::ServiceContainer ( const ServiceContainer & other )

delete

ServiceContainer() [3/3]

rtctk::componentFramework::ServiceContainer::ServiceContainer ( const ServiceContainer && other )

delete

~ServiceContainer()

rtctk::componentFramework::ServiceContainer::~ServiceContainer

(

)

Member Function Documentation

Add() [1/2]

template<typename Service >

void rtctk::componentFramework::ServiceContainer::Add ( Service && service, const std::string & name = "" )

inline

Insert new service into the container.

This overload is used to add non-pointer type services, which are moved into the container.

Template Parameters

Service,type

of the service.

Parameters

service	rvalue ref to the service.
name	name of the service.

Exceptions

rtctk::componentFramework::RtctkException

if service already registered

Add() [2/2]

template<typename Service >

void rtctk::componentFramework::ServiceContainer::Add ( std::shared_ptr< Service > service, const std::string & name = "" )

inline

Insert new service into the container.

This overload is used to add shared_pointer type services, which are copied into the container.

Template Parameters

Service,type

of the service.

Parameters

service	rvalue ref to the service.
name	name of the service.

Exceptions

rtctk::componentFramework::RtctkException

if service already registered

Contains()

template<typename Service >

bool rtctk::componentFramework::ServiceContainer::Contains ( const std::string & name = "" )

inline

Check if the service container holds a certain service.

Template Parameters

Service,type

of the service.

Parameters

name	optional: name of the service, if only 1 service of type Service is present, this argument can be ommited

Returns

true, if service is present, otherwise false

Get()

template<typename Service >

Service & rtctk::componentFramework::ServiceContainer::Get ( const std::string & name = "" )

inline

Get a handle to a service.

Template Parameters

Service,type

of the service.

Parameters

name	optional: name of the service, if only 1 service of type Service is present, this argument can be ommited

Returns

service handle by reference

Exceptions

rtctk::componentFramework::RtctkException

if service not found

List()

std::vector< std::string > rtctk::componentFramework::ServiceContainer::List

(

)

List currently available services.

Returns

vector of strings that describe services

operator=() [1/2]

ServiceContainer & rtctk::componentFramework::ServiceContainer::operator= ( const ServiceContainer & other )

delete

operator=() [2/2]

ServiceContainer & rtctk::componentFramework::ServiceContainer::operator= ( ServiceContainer && other )

delete

---

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

• componentFramework/services/common/src/include/rtctk/componentFramework/serviceContainer.hpp
• componentFramework/services/common/src/serviceContainer.cpp