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

a factory for DOMParsers. This factory defines an extension point for DOMParsers. Typically this is for parsing xml files, however, anything that parses from some stream or file into a DOM structure can be a DOMParser. More...

#include <DOMParser.hpp>

Inherits ExtensionPoint< DOMParser >.

Public Member Functions

 Factory ()
 constructor
 
- Public Member Functions inherited from ExtensionPoint< DOMParser >
 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
 

Static Public Member Functions

static rw::common::Ptr< DOMParsergetDOMParser (const std::string &format)
 get a DOM parser for a specific file format More...
 
static bool hasDOMParser (const std::string &format)
 check if the factory has a DOM parser for a specific format More...
 
static std::vector< std::string > getSupportedFormats ()
 get a list of supported formats More...
 

Additional Inherited Members

- Public Types inherited from ExtensionPoint< DOMParser >
typedef rw::common::Ptr< ExtensionPointPtr
 smart pointer type of ExtensionPoint
 
- Protected Member Functions inherited from ExtensionPoint< DOMParser >
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 DOMParsers. This factory defines an extension point for DOMParsers. Typically this is for parsing xml files, however, anything that parses from some stream or file into a DOM structure can be a DOMParser.

Member Function Documentation

◆ getDOMParser()

static rw::common::Ptr<DOMParser> getDOMParser ( const std::string &  format)
static

get a DOM parser for a specific file format

Parameters
format[in] the extension identifying the file format (without initial dot).
Returns
a parser if found, false otherwise.

◆ getSupportedFormats()

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

get a list of supported formats

Returns

◆ hasDOMParser()

static bool hasDOMParser ( const std::string &  format)
static

check if the factory has a DOM parser for a specific format

Parameters
format[in] file ending like: xml, ini, txt...
Returns

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