RobWorkProject
Public Member Functions | Static Public Member Functions | List of all members
XMLRWLoader Class Reference

this class loads a workcell in xml format from a filename. More...

#include <XMLRWLoader.hpp>

Inherits WorkCellLoader.

Public Member Functions

 XMLRWLoader ()
 default constructor
 
virtual ~XMLRWLoader ()
 constructor More...
 
models::WorkCell::Ptr loadWorkCell (const std::string &filename)
 load a workcell from file More...
 
- Public Member Functions inherited from WorkCellLoader
virtual ~WorkCellLoader ()
 destructor
 
virtual void setScene (rw::graphics::WorkCellScene::Ptr scene)
 set the scene that is used to create drawable models More...
 
virtual rw::graphics::WorkCellScene::Ptr getScene ()
 get the scene used to create a drawable scene More...
 

Static Public Member Functions

static rw::models::WorkCell::Ptr load (const std::string &filename)
 Loads/imports robwork workcell in XML file format. More...
 
static std::string getWorkCellFileNameId ()
 Returns the WorkCellFileName ID, to be used for getting the workcell filename. More...
 

Additional Inherited Members

- Public Types inherited from WorkCellLoader
typedef rw::common::Ptr< WorkCellLoaderPtr
 smart pointer of WorkCellLoader
 
- Protected Member Functions inherited from WorkCellLoader
 WorkCellLoader ()
 Constructor.
 
 WorkCellLoader (rw::graphics::WorkCellScene::Ptr scene)
 Constructor with a drawable scene. More...
 

Detailed Description

this class loads a workcell in xml format from a filename.

Constructor & Destructor Documentation

◆ ~XMLRWLoader()

virtual ~XMLRWLoader ( )
inlinevirtual

constructor

destructor

Member Function Documentation

◆ getWorkCellFileNameId()

static std::string getWorkCellFileNameId ( )
static

Returns the WorkCellFileName ID, to be used for getting the workcell filename.

Returns
WorkCell filename ID

◆ load()

static rw::models::WorkCell::Ptr load ( const std::string &  filename)
static

Loads/imports robwork workcell in XML file format.

An exception is thrown if the file can't be loaded.

Parameters
filename[in] filename of XML file

◆ loadWorkCell()

models::WorkCell::Ptr loadWorkCell ( const std::string &  filename)
virtual

load a workcell from file

Parameters
filename[in] path to workcell file

Implements WorkCellLoader.


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