Ignition Gazebo

API Reference

6.0.0~pre1
ComponentDescriptorBase Class Referenceabstract

A base class for an object responsible for creating components. More...

#include <Factory.hh>

Public Member Functions

virtual ~ComponentDescriptorBase ()=default
 Destructor. More...
 
virtual std::unique_ptr< BaseComponentCreate () const =0
 Create an instance of a Component. More...
 
virtual std::unique_ptr< BaseComponentCreate (const components::BaseComponent *_data) const =0
 Create an instance of a Component, populated with specific data. More...
 

Detailed Description

A base class for an object responsible for creating components.

Constructor & Destructor Documentation

◆ ~ComponentDescriptorBase()

virtual ~ComponentDescriptorBase ( )
virtualdefault

Destructor.

Member Function Documentation

◆ Create() [1/2]

virtual std::unique_ptr<BaseComponent> Create ( ) const
pure virtual

Create an instance of a Component.

Returns
Pointer to a component.

Implemented in ComponentDescriptor< ComponentTypeT >.

◆ Create() [2/2]

virtual std::unique_ptr<BaseComponent> Create ( const components::BaseComponent _data) const
pure virtual

Create an instance of a Component, populated with specific data.

Parameters
[in]_dataThe data to populate the component with.
Returns
Pointer to a component.

Implemented in ComponentDescriptor< ComponentTypeT >.


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