OpenRTM-aist 2.0.2
Loading...
Searching...
No Matches
RTC::FactoryBase Class Referenceabstract

FactoryBase base class. More...

#include <Factory.h>

Inheritance diagram for RTC::FactoryBase:

Public Member Functions

 FactoryBase (const coil::Properties &profile)
 Constructor.
 
virtual ~FactoryBase ()
 Destructor.
 
virtual RTObject_implcreate (Manager *mgr)=0
 Create components.
 
virtual void destroy (RTObject_impl *comp)=0
 Destroy components.
 
virtual coil::Properties & profile ()
 Get the component profile.
 
virtual int number ()
 Get the number of current instances.
 

Protected Attributes

coil::Properties m_Profile
 Component profile .
 
int m_Number
 Number of current RT-Component's instances. .
 

Detailed Description

FactoryBase base class.

This is a base class for RT-Component factory.

Since
0.2.0

Constructor & Destructor Documentation

◆ FactoryBase()

RTC::FactoryBase::FactoryBase ( const coil::Properties & profile)
explicit

Constructor.

Constructor.

Parameters
profileComponent profile

◆ ~FactoryBase()

virtual RTC::FactoryBase::~FactoryBase ( )
virtual

Destructor.

Destructor

Member Function Documentation

◆ create()

virtual RTObject_impl * RTC::FactoryBase::create ( Manager * mgr)
pure virtual

Create components.

Pure virtual function to create RT-Component's instances

Parameters
mgrManager object
Returns
Created RT-Components

Implemented in RTC::FactoryCXX.

◆ destroy()

virtual void RTC::FactoryBase::destroy ( RTObject_impl * comp)
pure virtual

Destroy components.

Pure virtual function to destroy RT-Component's instances

Parameters
compThe target RT-Component for destruction

Implemented in RTC::FactoryCXX.

◆ number()

virtual int RTC::FactoryBase::number ( )
virtual

Get the number of current instances.

Get the number of current RT-Component's instances.

Returns
Number of RT-Component's instances

◆ profile()

virtual coil::Properties & RTC::FactoryBase::profile ( )
virtual

Get the component profile.

Get the component profile.

Returns
The component profile

Referenced by RTC::Manager::FactoryPredicate::operator()(), and RTC::Manager::ModuleFactories::operator()().

Member Data Documentation

◆ m_Number

int RTC::FactoryBase::m_Number
protected

Number of current RT-Component's instances. .

◆ m_Profile

coil::Properties RTC::FactoryBase::m_Profile
protected

Component profile .


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