RobWorkProject  23.9.11-
Public Member Functions | Static Public Member Functions | List of all members
LuaState::Factory Class Reference

a factory for LuaLibrary. This factory also defines an extension point for LuaLibraries. This permit users to define extensions to the lua interfaces through RobWork extension. More...

#include <LuaState.hpp>

Inherits ExtensionPoint< LuaLibrary >.

Public Member Functions

 Factory ()
 constructor
 
- Public Member Functions inherited from ExtensionPoint< LuaLibrary >
 ExtensionPoint (const std::string &id, const std::string &name, Plugin *plugin=NULL)
 Constructor. More...
 
const std::string & getId () const
 get unique identifier of this extensionpoint
 
const std::string & getName () const
 get human readable name of this extension point
 
const rw::core::PropertyMapgetSchema () const
 the schema describe the possible properties/configurations elements which is used in the PropertyMap. It contain examples of all possible configuration options. This can be used to configure any extensions that needs to attach to this extension point.
 
std::vector< rw::core::Extension::DescriptorgetExtensionDescriptors () const
 get all extension descriptions of this extension point
 
std::vector< rw::core::Ptr< Extension > > getExtensions () const
 get all extensions of this extension point
 

Static Public Member Functions

static rw::core::Ptr< LuaLibrarygetLuaLibrary (const std::string &id)
 get a specific lua library based on id More...
 
static std::vector< LuaLibrary::PtrgetLuaLibraries ()
 get all avaliable lua libraries More...
 
static std::vector< std::string > getLuaLibraryIDs ()
 get a list of supported lua libraries More...
 

Additional Inherited Members

- Public Types inherited from ExtensionPoint< LuaLibrary >
typedef rw::core::Ptr< ExtensionPointPtr
 smart pointer type of ExtensionPoint
 
- Protected Member Functions inherited from ExtensionPoint< LuaLibrary >
rw::core::PropertyMapgetSchema ()
 the schema describe the possible properties/configurations elements which is used in the PropertyMap. The schema property map should just be loaded with all possible configuration options which the extension might use. More...
 

Detailed Description

a factory for LuaLibrary. This factory also defines an extension point for LuaLibraries. This permit users to define extensions to the lua interfaces through RobWork extension.

Member Function Documentation

◆ getLuaLibraries()

static std::vector<LuaLibrary::Ptr> getLuaLibraries ( )
static

get all avaliable lua libraries

Returns
all avalilable lua libraries

◆ getLuaLibrary()

static rw::core::Ptr<LuaLibrary> getLuaLibrary ( const std::string &  id)
static

get a specific lua library based on id

Parameters
id[in] string identifier of lua library
Returns
a lualibrary if matching lib exists else NULL

◆ getLuaLibraryIDs()

static std::vector<std::string> getLuaLibraryIDs ( )
static

get a list of supported lua libraries

Returns

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