Public Member Functions | Protected Attributes | List of all members
RTC::FactoryBase Class Referenceabstract

FactoryBase base class. More...

#include <Factory.h>

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

Public Member Functions

virtual RTObject_implcreate (Manager *mgr)=0
 Create components. More...
 
virtual void destroy (RTObject_impl *comp)=0
 Destroy components. More...
 
 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

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

Detailed Description

FactoryBase base class.

This is a base class for RT-Component factory.

Since
0.2.0

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

Constructor & Destructor Documentation

◆ FactoryBase()

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

Constructor.

Constructor.

Parameters
profileComponent profile

Definition at line 32 of file Factory.cpp.

◆ ~FactoryBase()

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

Destructor.

Destructor

Definition at line 44 of file Factory.cpp.

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()

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

Definition at line 67 of file Factory.cpp.

◆ profile()

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

Get the component profile.

Get the component profile.

Returns
The component profile

Definition at line 55 of file Factory.cpp.

Member Data Documentation

◆ m_Number

int RTC::FactoryBase::m_Number
protected

Number of current RT-Component's instances.

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

◆ m_Profile

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

Component profile.

Definition at line 253 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