RobWorkProject
Public Member Functions | Public Attributes | List of all members
Extension::Descriptor Struct Reference

An extension descriptor. More...

#include <Extension.hpp>

Public Member Functions

 Descriptor ()
 Construct empty descriptor.
 
 Descriptor (const std::string &id_, const std::string &point_)
 Construct new descriptor. More...
 
rw::common::PropertyMapgetProperties ()
 Get the extension properties. More...
 
const rw::common::PropertyMapgetProperties () const
 Get the extension properties. More...
 

Public Attributes

std::string id
 A unique id of an extension.
 
std::string name
 A human-readable name of an extension.
 
std::string point
 The extension point that this extension extends.
 
rw::common::PropertyMap props
 Properties of the extension.
 

Detailed Description

An extension descriptor.

The descriptor holds meta-data for an extension, and makes it possible to do lazy-loading of plugins.

Constructor & Destructor Documentation

◆ Descriptor()

Descriptor ( const std::string &  id_,
const std::string &  point_ 
)
inline

Construct new descriptor.

Parameters
id_[in] a unique id of the extension.
point_[in] the extension point.

Member Function Documentation

◆ getProperties() [1/2]

rw::common::PropertyMap& getProperties ( )
inline

Get the extension properties.

The properties will typically include information about the file extensions supported by the plugin, or other meta-data required to determine the proper extension to use.

Returns
a reference to the properties.

◆ getProperties() [2/2]

const rw::common::PropertyMap& getProperties ( ) const
inline

Get the extension properties.

The properties will typically include information about the file extensions supported by the plugin, or other meta-data required to determine the proper extension to use.

Returns
a reference to the properties.

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