IntegratorTest Class Reference

Common parent class for all integrator tests. More...

#include <IntegratorTest.hpp>

Inherits EngineTest.

Inherited by IntegratorGravityTest, IntegratorRotationTest, and IntegratorSpringTest.

Public Member Functions
	IntegratorTest ()
	Constructor.
virtual	~IntegratorTest ()
	Destructor.
virtual bool	isEngineSupported (const std::string &engineID) const
	Check if engine with specific name is supported by the test. More...
virtual rw::core::Ptr< rwsim::dynamics::DynamicWorkCell >	getDWC (const rw::core::PropertyMap &map)
	Get the dynamic workcell used by the test. More...
virtual rw::core::Ptr< rw::core::PropertyMap >	getDefaultParameters () const
	Get the default parameters used by the test. More...
virtual rw::core::Ptr< rwsim::dynamics::DynamicWorkCell >	makeIntegratorDWC (const std::string &integratorType="")
	Create new dynamic workcell. More...
Public Member Functions inherited from EngineTest
	EngineTest ()
	Construct new test.
virtual	~EngineTest ()
	Destructor.
virtual TestHandle::Ptr	runThread (const std::string &engineID, const rw::core::PropertyMap &parameters, rw::core::Ptr< rwsim::log::SimulatorLogScope > verbose, rw::core::Ptr< rw::common::ThreadTask > task)
	Run the test in a separate thread. More...
virtual void	run (TestHandle::Ptr handle, const std::string &engineID, const rw::core::PropertyMap &parameters, rw::core::Ptr< rwsim::log::SimulatorLogScope > verbose=NULL)=0
	Run the test. More...
virtual double	getRunTime () const =0
	Get the length of the simulation. More...
virtual std::vector< rw::core::Ptr< rw::core::PropertyMap > >	getPredefinedParameters () const
	Get a vector of predefined parameters. More...

Additional Inherited Members
Public Types inherited from EngineTest
typedef rw::core::Ptr< EngineTest >	Ptr
	Smart pointer to EngineTest.
typedef std::function< void(double time, bool failed, bool done)>	TimeCallback
	The callback type for the current simulation time.
Protected Types inherited from EngineTest
typedef std::function< void(rw::core::Ptr< const rwsim::dynamics::DynamicWorkCell >, rw::kinematics::State &)>	InitCallback
	Type for a function initializing the state.
typedef std::function< void(const EngineLoopInfo &)>	TestCallback
	Type for a callback function.
Protected Member Functions inherited from EngineTest
void	runEngineLoop (double dt, TestHandle::Ptr handle, const std::string &engineID, const rw::core::PropertyMap &parameters, rw::core::Ptr< rwsim::log::SimulatorLogScope > verbose, TestCallback callback=0, InitCallback initialize=0)
	A standard stepping loop provided as a convenience for test implementations. More...

Detailed Description

Common parent class for all integrator tests.

The class defines supported engines, common parameters, and a standard dynamic workcell.

Member Function Documentation

getDefaultParameters()

virtual rw::core::Ptr<rw::core::PropertyMap> getDefaultParameters ( ) const

virtual

Get the default parameters used by the test.

Returns

the default test parameters.

Reimplemented from EngineTest.

getDWC()

virtual rw::core::Ptr<rwsim::dynamics::DynamicWorkCell> getDWC ( const rw::core::PropertyMap &  map )

virtual

Get the dynamic workcell used by the test.

Parameters

map	[in] properties for test workcell.

Returns

a smart pointer to a dynamic workcell.

Implements EngineTest.

isEngineSupported()

virtual bool isEngineSupported ( const std::string &  engineID ) const

virtual

Check if engine with specific name is supported by the test.

Parameters

engineID

[in] the id of the engine.

Returns

true if supported, false otherwise.

Implements EngineTest.

makeIntegratorDWC()

virtual rw::core::Ptr<rwsim::dynamics::DynamicWorkCell> makeIntegratorDWC ( const std::string &  integratorType = "" )

virtual

Create new dynamic workcell.

Parameters

integratorType

[in] (optional) the integrator to use.

Returns

the dynamic workcell.

Reimplemented in IntegratorSpringTest, and IntegratorRotationTest.

---

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

• IntegratorTest.hpp