RobWorkProject  24.5.15-
Static Public Member Functions | List of all members
DOMProximitySetupLoader Class Reference

Loader for the XML PropertySetup format. More...

#include <DOMProximitySetupLoader.hpp>

Static Public Member Functions

static rw::proximity::ProximitySetup load (const std::string &filename, const std::string &schemaFileName="")
 Loads ProximitySetup from filename. More...
 
static rw::proximity::ProximitySetup load (std::istream &instream, const std::string &schemaFileName="")
 Loads ProximitySetup from instream. More...
 
static rw::proximity::ProximitySetup readProximitySetup (rw::core::Ptr< rw::core::DOMElem > element)
 Reads ProximitySetup from element. More...
 

Detailed Description

Loader for the XML PropertySetup format.

The loader is based on Xerces

Member Function Documentation

◆ load() [1/2]

static rw::proximity::ProximitySetup load ( const std::string &  filename,
const std::string &  schemaFileName = "" 
)
static

Loads ProximitySetup from filename.

Throws rw::core::Exception on errors

Parameters
filename[in] Name of input file
schemaFileName[in] Optional name of schema file to be used for verification
Returns
The ProximitySetup

◆ load() [2/2]

static rw::proximity::ProximitySetup load ( std::istream &  instream,
const std::string &  schemaFileName = "" 
)
static

Loads ProximitySetup from instream.

Throws rw::core::Exception on errors

Parameters
instream[in] Stream containing XML ProximitySetup
schemaFileName[in] Optional name of schema file to be used for verification
Returns
The ProximitySetup

◆ readProximitySetup()

static rw::proximity::ProximitySetup readProximitySetup ( rw::core::Ptr< rw::core::DOMElem element)
static

Reads ProximitySetup from element.

Throws rw::core::Exception on errors

Parameters
element[in] Element containing ProximitySetup
Returns
The ProximitySetup

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