Class which represents a user command, which can be "undone" and "redone". More...

Public Member Functions
	UserCmd (const unsigned int _id, physics::WorldPtr _world, const std::string &_description, const msgs::UserCmd::Type &_type)
	Constructor. More...

virtual	~UserCmd ()
	Destructor. More...

std::string	Description () const
	Return this command's description. More...

unsigned int	Id () const
	Return this command's unique ID. More...

virtual void	Redo ()
	Redo this command. More...

msgs::UserCmd::Type	Type () const
	Return this command's type. More...

virtual void	Undo ()
	Undo this command. More...

Detailed Description

Class which represents a user command, which can be "undone" and "redone".

Constructor & Destructor Documentation

gazebo::physics::UserCmd::UserCmd	(	const unsigned int	_id,
		physics::WorldPtr	_world,
		const std::string &	_description,
		const msgs::UserCmd::Type &	_type
	)

Constructor.

Parameters

[in]	_id	Unique ID for this command
[in]	_world	Pointer to the world
[in]	_description	Description for the command, such as "Rotate box", "Delete sphere", etc.
[in]	_type	Type of command, such as MOVING, DELETING, etc.

virtual gazebo::physics::UserCmd::~UserCmd ( )

virtual

Destructor.

std::string gazebo::physics::UserCmd::Description ( ) const

Return this command's description.

unsigned int gazebo::physics::UserCmd::Id ( ) const

Return this command's unique ID.

virtual void gazebo::physics::UserCmd::Redo ( )

virtual

Redo this command.

msgs::UserCmd::Type gazebo::physics::UserCmd::Type ( ) const

Return this command's type.

virtual void gazebo::physics::UserCmd::Undo ( )

virtual

Undo this command.

UserCmdPrivate* gazebo::physics::UserCmd::dataPtr

protected

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