head 1.4; access; symbols; locks; strict; comment @# @; 1.4 date 2002.09.07.01.50.36; author curt; state Exp; branches; next 1.3; 1.3 date 2002.08.31.19.01.50; author curt; state Exp; branches; next 1.2; 1.2 date 2002.08.31.18.53.58; author curt; state Exp; branches; next 1.1; 1.1 date 2002.02.15.17.21.54; author curt; state Exp; branches; next ; desc @@ 1.4 log @Updated doxygen docs. @ text @
Main Page Class Hierarchy Compound List File List Compound Members File Members

# SGCommandState Class Reference

Stored state for a command. More...

`#include <commands.hxx>`

List of all members.

## Public Methods
| SGCommandState ()
| SGCommandState (const SGPropertyNode *args)
virtual | ~SGCommandState ()
virtual void | setArgs (const SGPropertyNode *args)
virtual const SGPropertyNode * | getArgs () const

## Detailed Description

Stored state for a command.

This class allows a command to cache parts of its state between invocations with the same parameters. Nearly every command that actually uses this will subclass it in some way. The command allocates the structure, but it is up to the caller to delete it when it is no longer necessary, unless the command deletes it and replaces the value with 0 or another command-state object first.

Note that this class is for caching only; all of the information in it must be recoverable by other means, since the state could arbitrarily disappear between invocations if the caller decides to delete it.

By default, the command state includes a place to keep a copy of the parameters.

Author:
  David Megginson, david@@megginson.com

Definition at line 48 of file commands.hxx.

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

- commands.hxx
- commands.cxx

@ 1.3 log @Oops, try again. @ text @d50 1 a50 1