Public Member Functions | Protected Attributes | List of all members
RTC::FactoryCXX Class Reference

FactoryCXX class. More...

#include <Factory.h>

Inheritance diagram for RTC::FactoryCXX:
Inheritance graph
[legend]

Public Member Functions

virtual RTObject_implcreate (Manager *mgr)
 Create RT-Components. More...
 
virtual void destroy (RTObject_impl *comp)
 Destroy RT-Components. More...
 
 FactoryCXX (const coil::Properties &profile, RtcNewFunc new_func, RtcDeleteFunc delete_func, NumberingPolicy *policy=new DefaultNumberingPolicy())
 Constructor. More...
 
virtual ~FactoryCXX ()
 
- Public Member Functions inherited from RTC::FactoryBase
 FactoryBase (const coil::Properties &profile)
 Constructor. More...
 
virtual int number ()
 Get the number of current instances. More...
 
virtual coil::Propertiesprofile ()
 Get the component profile. More...
 
virtual ~FactoryBase (void)
 Destructor. More...
 

Protected Attributes

RtcDeleteFunc m_Delete
 The pointer to component object destroy function. More...
 
RtcNewFunc m_New
 The pointer to component object create function. More...
 
NumberingPolicym_policy
 The naming policy on creating the components. More...
 
- Protected Attributes inherited from RTC::FactoryBase
int m_Number
 Number of current RT-Component's instances. More...
 
coil::Properties m_Profile
 Component profile. More...
 

Detailed Description

FactoryCXX class.

RT-Component factory class for C++.

Since
0.2.0

Definition at line 286 of file rtm/Factory.h.

Constructor & Destructor Documentation

◆ FactoryCXX()

RTC::FactoryCXX::FactoryCXX ( const coil::Properties profile,
RtcNewFunc  new_func,
RtcDeleteFunc  delete_func,
NumberingPolicy policy = new DefaultNumberingPolicy() 
)

Constructor.

Constructor. Create component factory class with three arguments: component profile, function pointer to object create function and object destroy function.

Parameters
profileComponent profile
new_funcPointer to component create function
delete_funcPointer to component destroy function
policyThe naming policy at component creation (The default value:DefaultNumberingPolicy)

Definition at line 79 of file Factory.cpp.

◆ ~FactoryCXX()

virtual RTC::FactoryCXX::~FactoryCXX ( )
inlinevirtual

Definition at line 328 of file rtm/Factory.h.

Member Function Documentation

◆ create()

RTObject_impl * RTC::FactoryCXX::create ( Manager mgr)
virtual

Create RT-Components.

Create RT-Component's instances

Parameters
mgrManager object
Returns
Created RT-Components

Implements RTC::FactoryBase.

Definition at line 99 of file Factory.cpp.

◆ destroy()

void RTC::FactoryCXX::destroy ( RTObject_impl comp)
virtual

Destroy RT-Components.

Destroy RT-Component's instances

Parameters
compThe target RT-Component for destruction

Implements RTC::FactoryBase.

Definition at line 129 of file Factory.cpp.

Member Data Documentation

◆ m_Delete

RtcDeleteFunc RTC::FactoryCXX::m_Delete
protected

The pointer to component object destroy function.

Definition at line 396 of file rtm/Factory.h.

◆ m_New

RtcNewFunc RTC::FactoryCXX::m_New
protected

The pointer to component object create function.

Definition at line 387 of file rtm/Factory.h.

◆ m_policy

NumberingPolicy* RTC::FactoryCXX::m_policy
protected

The naming policy on creating the components.

Definition at line 405 of file rtm/Factory.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:47