Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

UNDISPLAY_CMD Class Reference

Remove a GEL or GELs from the WORLD's display list. More...

#include <command.H>

Inheritance diagram for UNDISPLAY_CMD:

Inheritance graph
[legend]
Collaboration diagram for UNDISPLAY_CMD:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void Own () const
void Free () const
int Lock ()
void Unlock ()
int Unique () const
Run-Time Type Id
 DEFINE_RTTI_METHODS_BASE ("COMMAND", CCOMMAND *)
Accessors
bool is_clear () const
 Neither doit() nor undoit() have been called.
bool is_done () const
 doit() was called most recently.
bool is_undone () const
 undoit() was called most recently, after doit().
Run-Time Type Id
 DEFINE_RTTI_METHODS_BASE ("COMMAND", CCOMMAND *)
Accessors
bool is_clear () const
 Neither doit() nor undoit() have been called.
bool is_done () const
 doit() was called most recently.
bool is_undone () const
 undoit() was called most recently, after doit().
Run-Time Type Id
 DEFINE_RTTI_METHODS3 ("UNDO_CMD", UNDO_CMD *, COMMAND, CCOMMAND *)
Command Virtual Methods
virtual bool doit ()
 Execute the command.
virtual bool undoit ()
 Undo the command.
virtual bool clear ()
 After doit() and undoit() were called, restore things to the way they were before (may be a no-op for most derived classes).
Diagnostic
virtual void print () const
Run-Time Type Id
 DEFINE_RTTI_METHODS_BASE ("COMMAND", CCOMMAND *)
Accessors
bool is_clear () const
 Neither doit() nor undoit() have been called.
bool is_done () const
 doit() was called most recently.
bool is_undone () const
 undoit() was called most recently, after doit().
Run-Time Type Id
 DEFINE_RTTI_METHODS3 ("UNDO_CMD", UNDO_CMD *, COMMAND, CCOMMAND *)
Command Virtual Methods
virtual bool doit ()
 Execute the command.
virtual bool undoit ()
 Undo the command.
virtual bool clear ()
 After doit() and undoit() were called, restore things to the way they were before (may be a no-op for most derived classes).
Diagnostic
virtual void print () const
Run-Time Type Id
 DEFINE_RTTI_METHODS_BASE ("COMMAND", CCOMMAND *)
Accessors
bool is_clear () const
 Neither doit() nor undoit() have been called.
bool is_done () const
 doit() was called most recently.
bool is_undone () const
 undoit() was called most recently, after doit().
Run-Time Type Id
 DEFINE_RTTI_METHODS_BASE ("COMMAND", CCOMMAND *)
Accessors
bool is_clear () const
 Neither doit() nor undoit() have been called.
bool is_done () const
 doit() was called most recently.
bool is_undone () const
 undoit() was called most recently, after doit().
Run-Time Type Id
 DEFINE_RTTI_METHODS_BASE ("COMMAND", CCOMMAND *)
Accessors
bool is_clear () const
 Neither doit() nor undoit() have been called.
bool is_done () const
 doit() was called most recently.
bool is_undone () const
 undoit() was called most recently, after doit().
Constructors
 UNDISPLAY_CMD (CGELptr &gel)
 UNDISPLAY_CMD (CGELlist &gels)
Run-Time Type Id
 DEFINE_RTTI_METHODS3 ("UNDISPLAY_CMD", UNDISPLAY_CMD *, UNDO_CMD, CCOMMAND *)
Run-Time Type Id
 DEFINE_RTTI_METHODS3 ("UNDO_CMD", UNDO_CMD *, COMMAND, CCOMMAND *)
Command Virtual Methods
virtual bool doit ()
 Execute the command.
virtual bool undoit ()
 Undo the command.
virtual bool clear ()
 After doit() and undoit() were called, restore things to the way they were before (may be a no-op for most derived classes).
Diagnostic
virtual void print () const
Run-Time Type Id
 DEFINE_RTTI_METHODS_BASE ("COMMAND", CCOMMAND *)
Accessors
bool is_clear () const
 Neither doit() nor undoit() have been called.
bool is_done () const
 doit() was called most recently.
bool is_undone () const
 undoit() was called most recently, after doit().
Run-Time Type Id
 DEFINE_RTTI_METHODS3 ("UNDO_CMD", UNDO_CMD *, COMMAND, CCOMMAND *)
Command Virtual Methods
virtual bool doit ()
 Execute the command.
virtual bool undoit ()
 Undo the command.
virtual bool clear ()
 After doit() and undoit() were called, restore things to the way they were before (may be a no-op for most derived classes).
Diagnostic
virtual void print () const
Run-Time Type Id
 DEFINE_RTTI_METHODS_BASE ("COMMAND", CCOMMAND *)
Accessors
bool is_clear () const
 Neither doit() nor undoit() have been called.
bool is_done () const
 doit() was called most recently.
bool is_undone () const
 undoit() was called most recently, after doit().

Protected Attributes

COMMANDptr _cmd
bool _is_done
 true if doit() was executed most recently.
bool _is_undone
 true if undoit() was executed most recently.

Detailed Description

Remove a GEL or GELs from the WORLD's display list.

Questions:
Should this class be moved to a different header (since it is a concrete COMMAND rather than an abstract command)?

Definition at line 247 of file command.H.

Constructor & Destructor Documentation

UNDISPLAY_CMD::UNDISPLAY_CMD (  CGELptr &  gel  )  [inline]
 

Definition at line 253 of file command.H.

UNDISPLAY_CMD::UNDISPLAY_CMD (  CGELlist &  gels  )  [inline]
 

Definition at line 254 of file command.H.

Member Function Documentation

bool UNDO_CMD::clear (   )  [virtual, inherited]
 

After doit() and undoit() were called, restore things to the way they were before (may be a no-op for most derived classes).

Reimplemented from COMMAND.

Definition at line 53 of file command.C.

References UNDO_CMD::_cmd, and COMMAND::clear().

UNDO_CMD::DEFINE_RTTI_METHODS3 (  "UNDO_CMD"  ,
UNDO_CMD *  ,
COMMAND  ,
CCOMMAND * 
)  [inherited]
 

UNDISPLAY_CMD::DEFINE_RTTI_METHODS3 (  "UNDISPLAY_CMD"  ,
UNDISPLAY_CMD *  ,
UNDO_CMD  ,
CCOMMAND * 
) 
 

COMMAND::DEFINE_RTTI_METHODS_BASE (  "COMMAND"  ,
CCOMMAND * 
)  [inherited]
 

bool UNDO_CMD::doit (   )  [virtual, inherited]
 

Execute the command.

Returns:
true on success. If the command is already done, this is a no-op and still returns true.

Reimplemented from COMMAND.

Definition at line 37 of file command.C.

References UNDO_CMD::_cmd, and COMMAND::doit().

void REFcounter::Free (   )  const [inline, inherited]
 

Definition at line 76 of file ref.H.

References REFcounter::_mutex, REFcounter::_u, and REF_ME.

bool COMMAND::is_clear (   )  const [inline, inherited]
 

Neither doit() nor undoit() have been called.

Definition at line 91 of file command.H.

References COMMAND::_is_done, and COMMAND::_is_undone.

bool COMMAND::is_done (   )  const [inline, inherited]
 

doit() was called most recently.

Definition at line 94 of file command.H.

References COMMAND::_is_done.

Referenced by COMMAND::clear().

bool COMMAND::is_undone (   )  const [inline, inherited]
 

undoit() was called most recently, after doit().

Definition at line 97 of file command.H.

References COMMAND::_is_undone.

int REFcounter::Lock (   )  [inline, inherited]
 

Definition at line 105 of file ref.H.

References REFcounter::_mutex, and REFcounter::_u.

Referenced by REFlock::REFlock().

void REFcounter::Own (   )  const [inline, inherited]
 

Definition at line 59 of file ref.H.

References REFcounter::_mutex, REFcounter::_u, and REF_ME.

virtual void UNDO_CMD::print (   )  const [inline, virtual, inherited]
 

Reimplemented from COMMAND.

Definition at line 170 of file command.H.

References UNDO_CMD::_cmd.

bool UNDO_CMD::undoit (   )  [virtual, inherited]
 

Undo the command.

Returns:
true on success. If the command is already undone, this is a no-op and still returns true.

Reimplemented from COMMAND.

Definition at line 45 of file command.C.

References UNDO_CMD::_cmd, and COMMAND::undoit().

int REFcounter::Unique (   )  const [inline, inherited]
 

Definition at line 115 of file ref.H.

References REFcounter::_mutex, and REFcounter::_u.

void REFcounter::Unlock (   )  [inline, inherited]
 

Definition at line 111 of file ref.H.

References REFcounter::_mutex, and REFcounter::_u.

Referenced by REFlock::~REFlock().

Member Data Documentation

COMMANDptr UNDO_CMD::_cmd [protected, inherited]
 

Definition at line 180 of file command.H.

Referenced by UNDO_CMD::clear(), UNDO_CMD::doit(), UNDO_CMD::print(), and UNDO_CMD::undoit().

bool COMMAND::_is_done [protected, inherited]
 

true if doit() was executed most recently.

Definition at line 129 of file command.H.

Referenced by COMMAND::clear(), COMMAND::doit(), COMMAND::is_clear(), COMMAND::is_done(), and COMMAND::undoit().

bool COMMAND::_is_undone [protected, inherited]
 

true if undoit() was executed most recently.

Definition at line 130 of file command.H.

Referenced by COMMAND::clear(), COMMAND::doit(), COMMAND::is_clear(), COMMAND::is_undone(), and COMMAND::undoit().

The documentation for this class was generated from the following file:
Generated on Mon Sep 18 11:47:41 2006 for jot by  doxygen 1.4.4