Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends
Command Class Reference

The abstract parent class of all the command classes. Commands are non-copyable. More...

#include <command.h>

Inheritance diagram for Command:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~Command ()
 Destructor.

Protected Member Functions

 Command ()
 The default constructor.
virtual void execute ()=0
 Executes the command.
bool hasUndo () const
 Returns true if the command has an undo function.
virtual void undo ()=0
 Undos the command.

Protected Attributes

bool has_undo_
 a flag indicates whether the command has an undo function.

Private Member Functions

 Command (const Command &)
 Copy Constructor - object is non-copyable.
Commandoperator= (const Command &)
 Equal Operator - object is non-copyable.

Friends

class CommandQueue

Detailed Description

The abstract parent class of all the command classes. Commands are non-copyable.

Definition at line 49 of file command.h.


Constructor & Destructor Documentation

virtual Command::~Command ( ) [inline, virtual]

Destructor.

Definition at line 53 of file command.h.

Command::Command ( ) [inline, protected]

The default constructor.

Derived commands are assumed to have undo by default. Each is free to override this.

Definition at line 65 of file command.h.

Command::Command ( const Command ) [inline, private]

Copy Constructor - object is non-copyable.

Definition at line 92 of file command.h.


Member Function Documentation

virtual void Command::execute ( ) [protected, pure virtual]

Executes the command.

Implemented in CopyCommand, DenoiseCommand, PasteCommand, TransformCommand, CutCommand, and DeleteCommand.

bool Command::hasUndo ( ) const [inline, protected]

Returns true if the command has an undo function.

Definition at line 72 of file command.h.

Command& Command::operator= ( const Command ) [inline, private]

Equal Operator - object is non-copyable.

Definition at line 99 of file command.h.

virtual void Command::undo ( ) [protected, pure virtual]

Undos the command.

Implemented in CopyCommand, DenoiseCommand, CutCommand, PasteCommand, TransformCommand, and DeleteCommand.


Friends And Related Function Documentation

friend class CommandQueue [friend]

Allows command queues to be the only objects which are able to execute commands.

Definition at line 60 of file command.h.


Member Data Documentation

bool Command::has_undo_ [protected]

a flag indicates whether the command has an undo function.

Definition at line 88 of file command.h.


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


pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:38:49