IfaceBaseCommand Class Reference

A root class for a basic set of commands. More...

#include <interface.hh>

Inheritance diagram for IfaceBaseCommand:

Collaboration diagram for IfaceBaseCommand:

Public Member Functions
virtual void	setData (IfaceStatus *root, IfaceData *data)
	Associate a specific data object with this command. More...
virtual string	getModule (void) const
	Get the formal module name to which this command belongs. More...
virtual IfaceData *	createData (void)
	Create a specialized data object for this command (and its module) More...
Public Member Functions inherited from IfaceCommand
virtual void	execute (istream &s)=0
void	addWord (const string &temp)
	Add a token to the command line string associated with this command. More...
void	addWords (const vector< string > &wordlist)
	Add words to the associated command line string.
void	commandString (string &res) const
	Get the complete command line string. More...
int4	compare (const IfaceCommand &op2) const
	Order two commands by their command line strings. More...

Protected Attributes
IfaceStatus *	status
	The interface owning this command instance.

Detailed Description

A root class for a basic set of commands.

Commands derived from this class are in the "base" module. They are useful as part of any interface

Member Function Documentation

createData()

virtual IfaceData* IfaceBaseCommand::createData ( void  )

inlinevirtual

Create a specialized data object for this command (and its module)

This method is only called once per module

Returns

the newly created data object for the module

Implements IfaceCommand.

getModule()

virtual string IfaceBaseCommand::getModule ( void  ) const

inlinevirtual

Get the formal module name to which this command belongs.

Commands in the same module share data through their registered IfaceData object

Returns

the formal module name

Implements IfaceCommand.

setData()

virtual void IfaceBaseCommand::setData ( IfaceStatus *  root, IfaceData *  data  )

inlinevirtual

Associate a specific data object with this command.

Parameters

root	is the interface object this command is registered with
data	is the data object the command should use

Implements IfaceCommand.

---

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

• interface.hh