#include <ConstraintsPlugin.h>

Public Member Functions
	ConstraintsPlugin (lib_manager::LibManager *theManager)

	~ConstraintsPlugin ()

int	getLibVersion () const

const std::string	getLibName () const

	CREATE_MODULE_INFO ()

void	init ()

void	reset ()

void	update (interfaces::sReal time_ms)

void	loadConstraintDefs (const std::string &filename)

void	saveConstraintDefs (const std::string &filename) const

void	loadConstraints (const std::string &filename)

void	saveConstraints (const std::string &filename) const

void	loadMotors (const std::string &filename)

void	saveMotors (const std::string &filename) const

void	parseNodeConstraints (const std::string &paramName, const std::string &s)

AttributeType	parseAttribute (const std::string &attributeString)

double	getNodeAttribute (interfaces::NodeId nodeId, AttributeType attr)

void	cfgUpdateProperty (cfg_manager::cfgPropertyStruct property)

void	cfgParamCreated (cfg_manager::cfgParamId id)

void	cfgParamRemoved (cfg_manager::cfgParamId id)

void	menuAction (int action, bool checked=false)
	Called whenever a menu item is selected. More...

Public Member Functions inherited from mars::interfaces::MarsPluginTemplate
	MarsPluginTemplate (lib_manager::LibManager *theManager, std::string libName)

	~MarsPluginTemplate ()

Public Member Functions inherited from lib_manager::LibInterface
	LibInterface (LibManager *theManager)

virtual	~LibInterface (void)

ModuleInfo	getModuleInfo () const

virtual void	newLibLoaded (const std::string &libName)

virtual void	createModuleInfo (void)

Public Member Functions inherited from mars::interfaces::PluginInterface
	PluginInterface (ControlCenter *control)

virtual	~PluginInterface (void)

virtual void	handleError (void)

virtual void	getSomeData (void *data)

Public Member Functions inherited from mars::cfg_manager::CFGClient
	CFGClient ()

virtual	~CFGClient ()

Public Member Functions inherited from mars::main_gui::MenuInterface
virtual	~MenuInterface ()

Private Types
typedef std::vector< BaseConstraint * >	ConstraintsContainer

typedef std::map< cfg_manager::cfgParamId, ConstraintsContainer >	ConstraintsLookup

Private Member Functions
ParseResult	parseIdentifier (const std::string &s, size_t pos, interfaces::NodeId nodeId, AttributeType attr, double offset, double *factor)

void	parseConstraintFromString (const std::string &name, const std::string &s)

Private Attributes
ConstraintsLookup	constraints

main_gui::GuiInterface *	gui

Additional Inherited Members
Protected Attributes inherited from mars::interfaces::MarsPluginTemplate
std::string	configPath

std::string	resourcesPath

Protected Attributes inherited from lib_manager::LibInterface
LibManager *	libManager

ModuleInfo	moduleInfo

Protected Attributes inherited from mars::interfaces::PluginInterface
ControlCenter *	control

Detailed Description

Definition at line 59 of file ConstraintsPlugin.h.

Member Typedef Documentation

◆ ConstraintsContainer

typedef std::vector<BaseConstraint*> mars::plugins::constraints_plugin::ConstraintsPlugin::ConstraintsContainer

private

Definition at line 105 of file ConstraintsPlugin.h.

◆ ConstraintsLookup

typedef std::map<cfg_manager::cfgParamId, ConstraintsContainer> mars::plugins::constraints_plugin::ConstraintsPlugin::ConstraintsLookup

private

Definition at line 106 of file ConstraintsPlugin.h.

Constructor & Destructor Documentation

◆ ConstraintsPlugin()

mars::plugins::constraints_plugin::ConstraintsPlugin::ConstraintsPlugin ( lib_manager::LibManager * theManager )

Definition at line 63 of file ConstraintsPlugin.cpp.

◆ ~ConstraintsPlugin()

mars::plugins::constraints_plugin::ConstraintsPlugin::~ConstraintsPlugin ( )

Definition at line 70 of file ConstraintsPlugin.cpp.

Member Function Documentation

◆ cfgParamCreated()

void mars::plugins::constraints_plugin::ConstraintsPlugin::cfgParamCreated ( cfg_manager::cfgParamId id )

virtual

Reimplemented from mars::cfg_manager::CFGClient.

Definition at line 159 of file ConstraintsPlugin.cpp.

◆ cfgParamRemoved()

void mars::plugins::constraints_plugin::ConstraintsPlugin::cfgParamRemoved ( cfg_manager::cfgParamId id )

virtual

Reimplemented from mars::cfg_manager::CFGClient.

Definition at line 365 of file ConstraintsPlugin.cpp.

◆ cfgUpdateProperty()

void mars::plugins::constraints_plugin::ConstraintsPlugin::cfgUpdateProperty ( cfg_manager::cfgPropertyStruct property )

virtual

Reimplemented from mars::cfg_manager::CFGClient.

Definition at line 139 of file ConstraintsPlugin.cpp.

◆ CREATE_MODULE_INFO()

mars::plugins::constraints_plugin::ConstraintsPlugin::CREATE_MODULE_INFO ( )

◆ getLibName()

const std::string mars::plugins::constraints_plugin::ConstraintsPlugin::getLibName ( ) const

inlinevirtual

Implements lib_manager::LibInterface.

Definition at line 69 of file ConstraintsPlugin.h.

◆ getLibVersion()

int mars::plugins::constraints_plugin::ConstraintsPlugin::getLibVersion ( ) const

inlinevirtual

Implements lib_manager::LibInterface.

Definition at line 68 of file ConstraintsPlugin.h.

◆ getNodeAttribute()

double mars::plugins::constraints_plugin::ConstraintsPlugin::getNodeAttribute	(	interfaces::NodeId	nodeId,
		AttributeType	attr
	)

Definition at line 189 of file ConstraintsPlugin.cpp.

◆ init()

void mars::plugins::constraints_plugin::ConstraintsPlugin::init ( void )

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 80 of file ConstraintsPlugin.cpp.

◆ loadConstraintDefs()

void mars::plugins::constraints_plugin::ConstraintsPlugin::loadConstraintDefs ( const std::string & filename )

Definition at line 91 of file ConstraintsPlugin.cpp.

◆ loadConstraints()

void mars::plugins::constraints_plugin::ConstraintsPlugin::loadConstraints ( const std::string & filename )

Definition at line 101 of file ConstraintsPlugin.cpp.

◆ loadMotors()

void mars::plugins::constraints_plugin::ConstraintsPlugin::loadMotors ( const std::string & filename )

Definition at line 111 of file ConstraintsPlugin.cpp.

◆ menuAction()

void mars::plugins::constraints_plugin::ConstraintsPlugin::menuAction	(	int	action,
		bool	checked = `false`
	)

virtual

Called whenever a menu item is selected.

Parameters

action	The action that is passed to the GuiInterface via addGenericMenuAction function.
checked	Indicates if the menu/menu item is checked or not.

Implements mars::main_gui::MenuInterface.

Definition at line 391 of file ConstraintsPlugin.cpp.

◆ parseAttribute()

AttributeType mars::plugins::constraints_plugin::ConstraintsPlugin::parseAttribute ( const std::string & attributeString )

Definition at line 340 of file ConstraintsPlugin.cpp.

◆ parseConstraintFromString()

void mars::plugins::constraints_plugin::ConstraintsPlugin::parseConstraintFromString	(	const std::string &	name,
		const std::string &	s
	)

private

Definition at line 176 of file ConstraintsPlugin.cpp.

◆ parseIdentifier()

ParseResult mars::plugins::constraints_plugin::ConstraintsPlugin::parseIdentifier	(	const std::string &	s,
		size_t *	pos,
		interfaces::NodeId *	nodeId,
		AttributeType *	attr,
		double *	offset,
		double *	factor
	)

private

Definition at line 274 of file ConstraintsPlugin.cpp.

◆ parseNodeConstraints()

void mars::plugins::constraints_plugin::ConstraintsPlugin::parseNodeConstraints	(	const std::string &	paramName,
		const std::string &	s
	)

Definition at line 234 of file ConstraintsPlugin.cpp.

◆ reset()

void mars::plugins::constraints_plugin::ConstraintsPlugin::reset ( void )

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 376 of file ConstraintsPlugin.cpp.

◆ saveConstraintDefs()

void mars::plugins::constraints_plugin::ConstraintsPlugin::saveConstraintDefs ( const std::string & filename ) const

Definition at line 96 of file ConstraintsPlugin.cpp.

◆ saveConstraints()

void mars::plugins::constraints_plugin::ConstraintsPlugin::saveConstraints ( const std::string & filename ) const

Definition at line 106 of file ConstraintsPlugin.cpp.

◆ saveMotors()

void mars::plugins::constraints_plugin::ConstraintsPlugin::saveMotors ( const std::string & filename ) const

Definition at line 123 of file ConstraintsPlugin.cpp.

◆ update()

void mars::plugins::constraints_plugin::ConstraintsPlugin::update ( interfaces::sReal time_ms )

virtual

Implements mars::interfaces::PluginInterface.

Definition at line 386 of file ConstraintsPlugin.cpp.

Member Data Documentation

◆ constraints

ConstraintsLookup mars::plugins::constraints_plugin::ConstraintsPlugin::constraints

private

Definition at line 107 of file ConstraintsPlugin.h.

◆ gui

main_gui::GuiInterface* mars::plugins::constraints_plugin::ConstraintsPlugin::gui

private

Definition at line 108 of file ConstraintsPlugin.h.

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

/Developer/bob-learning-dev/simulation/mars/plugins/constraint_plugin/src/ConstraintsPlugin.h
/Developer/bob-learning-dev/simulation/mars/plugins/constraint_plugin/src/ConstraintsPlugin.cpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstraintsContainer

◆ ConstraintsLookup

Constructor & Destructor Documentation

◆ ConstraintsPlugin()

◆ ~ConstraintsPlugin()

Member Function Documentation

◆ cfgParamCreated()

◆ cfgParamRemoved()

◆ cfgUpdateProperty()

◆ CREATE_MODULE_INFO()

◆ getLibName()

◆ getLibVersion()

◆ getNodeAttribute()

◆ init()

◆ loadConstraintDefs()

◆ loadConstraints()

◆ loadMotors()

◆ menuAction()

◆ parseAttribute()

◆ parseConstraintFromString()

◆ parseIdentifier()

◆ parseNodeConstraints()

◆ reset()

◆ saveConstraintDefs()

◆ saveConstraints()

◆ saveMotors()

◆ update()

Member Data Documentation

◆ constraints

◆ gui