RobWorkProject
Static Public Member Functions | List of all members
SimulatorLogEntry::Factory Class Reference

A factory for a SimulatorLogEntry. This factory also defines an extension point for SimulatorLogEntry. More...

#include <SimulatorLogEntry.hpp>

Inherits ExtensionPoint< SimulatorLogEntry >.

Static Public Member Functions

static std::vector< std::string > getEntryTypes ()
 Get the available entry types. More...
 
static bool hasEntryType (const std::string &entryType)
 Check if entry type is available. More...
 
static SimulatorLogEntry::Ptr makeEntry (const std::string &entryType, SimulatorLogScope *parent)
 Create a new entry. More...
 

Additional Inherited Members

- Public Types inherited from ExtensionPoint< SimulatorLogEntry >
typedef rw::common::Ptr< ExtensionPointPtr
 smart pointer type of ExtensionPoint
 
- Public Member Functions inherited from ExtensionPoint< SimulatorLogEntry >
 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::common::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< Extension::DescriptorgetExtensionDescriptors () const
 get all extension descriptions of this extension point
 
std::vector< rw::common::Ptr< Extension > > getExtensions () const
 get all extensions of this extension point
 
- Protected Member Functions inherited from ExtensionPoint< SimulatorLogEntry >
rw::common::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 a SimulatorLogEntry. This factory also defines an extension point for SimulatorLogEntry.

Member Function Documentation

◆ getEntryTypes()

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

Get the available entry types.

Returns
a vector of entry types.

◆ hasEntryType()

static bool hasEntryType ( const std::string &  entryType)
static

Check if entry type is available.

Parameters
entryType[in] the name of the entry type.
Returns
true if available, false otherwise.

◆ makeEntry()

static SimulatorLogEntry::Ptr makeEntry ( const std::string &  entryType,
SimulatorLogScope parent 
)
static

Create a new entry.

Parameters
entryType[in] the type of entry.
parent[in] the parent scope.
Returns
a pointer to a new entry.

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