DtStealthCommand Class Reference

The DtStealthCommand is an instance of a stealth command and variables that are used to satisfy the stealth command. More...

Public Member Functions
	DtStealthCommand ()
	default constructor
	DtStealthCommand (const DtStealthCommand &)
	copy constructor
virtual	~DtStealthCommand ()
	destructor
DtStealthCommand &	operator= (const DtStealthCommand &orig)
	assignment operator: assigns value only
virtual bool	variable (const std::string &s, DtScriptedTaskVariable &var) const
	Returns the variable associated with the given variable.
virtual void	setStealthCommand (const DtString &)
const DtString &	stealthCommand () const
virtual void	setDisplayName (const DtString &)
const DtString &	displayName () const
virtual char *	setToNet (char *buffer) const
virtual const char *	setFromNet (const char *buffer)
virtual int	netRepSize () const
virtual void	setVariables (const std::vector< DtScriptedTaskVariable > &)
virtual void	addVariable (const DtScriptedTaskVariable &)
virtual void	insertVariableBefore (const DtScriptedTaskVariable &, const std::string &variable)
virtual void	insertVariableBefore (const DtScriptedTaskVariable &, int i)
virtual void	removeVariable (const std::string &)
virtual void	removeVariable (int)
virtual std::vector < DtScriptedTaskVariable >	variables () const
virtual DtRwVariableBindings *	defaultVariableBindings () const
	Returns a variable binding list of all the variables default values.
virtual void	setupDefaultsFromBindings (const DtRwVariableBindings &)
	Sets the default variables from the bindings.

Protected Attributes
DtString	myStealthCommand
DtString	myDisplayName
std::vector< std::string >	myVariables

Detailed Description

The DtStealthCommand is an instance of a stealth command and variables that are used to satisfy the stealth command.

This is only the object that defines the command – it does not execute it

Constructor & Destructor Documentation

DtStealthCommand::DtStealthCommand

(

)

default constructor

DtStealthCommand::DtStealthCommand

(

const DtStealthCommand &

)

copy constructor

virtual DtStealthCommand::~DtStealthCommand ( )

virtual

destructor

Member Function Documentation

DtStealthCommand& DtStealthCommand::operator=

(

const DtStealthCommand &

orig

)

assignment operator: assigns value only

virtual void DtStealthCommand::setStealthCommand ( const DtString &  )

virtual

Stealth command accessors

const DtString& DtStealthCommand::stealthCommand ( ) const

inline

Stealth command accessors

virtual void DtStealthCommand::setDisplayName ( const DtString &  )

virtual

Display name accessors

const DtString& DtStealthCommand::displayName ( ) const

inline

Display name accessors

virtual char* DtStealthCommand::setToNet ( char *  buffer ) const

virtual

Used from buffer serialize

virtual const char* DtStealthCommand::setFromNet ( const char *  buffer )

virtual

Display name accessors

virtual int DtStealthCommand::netRepSize ( ) const

virtual

Display name accessors

virtual bool DtStealthCommand::variable ( const std::string &  s, DtScriptedTaskVariable &  var  ) const

virtual

Returns the variable associated with the given variable.

If no variable of that name returns false

virtual void DtStealthCommand::setVariables ( const std::vector< DtScriptedTaskVariable > &  )

virtual

Accessor for the variables that are part of this scripted task. The variables will be referenced by their bound name. The order in which they appear in the UI will be the order in which they appear in the variables list

virtual void DtStealthCommand::addVariable ( const DtScriptedTaskVariable &  )

virtual

Accessor for the variables that are part of this scripted task. The variables will be referenced by their bound name. The order in which they appear in the UI will be the order in which they appear in the variables list

virtual void DtStealthCommand::insertVariableBefore ( const DtScriptedTaskVariable &  , const std::string &  variable  )

virtual

Accessor for the variables that are part of this scripted task. The variables will be referenced by their bound name. The order in which they appear in the UI will be the order in which they appear in the variables list

virtual void DtStealthCommand::insertVariableBefore ( const DtScriptedTaskVariable &  , int  i  )

virtual

Accessor for the variables that are part of this scripted task. The variables will be referenced by their bound name. The order in which they appear in the UI will be the order in which they appear in the variables list

virtual void DtStealthCommand::removeVariable ( const std::string &  )

virtual

Accessor for the variables that are part of this scripted task. The variables will be referenced by their bound name. The order in which they appear in the UI will be the order in which they appear in the variables list

virtual void DtStealthCommand::removeVariable ( int  )

virtual

Accessor for the variables that are part of this scripted task. The variables will be referenced by their bound name. The order in which they appear in the UI will be the order in which they appear in the variables list

virtual std::vector<DtScriptedTaskVariable> DtStealthCommand::variables ( ) const

virtual

Accessor for the variables that are part of this scripted task. The variables will be referenced by their bound name. The order in which they appear in the UI will be the order in which they appear in the variables list

virtual DtRwVariableBindings* DtStealthCommand::defaultVariableBindings ( ) const

virtual

Returns a variable binding list of all the variables default values.

This is to be considered a read-only view into the default values. You must also free the return pointer when you are done with it

virtual void DtStealthCommand::setupDefaultsFromBindings ( const DtRwVariableBindings &  )

virtual

Sets the default variables from the bindings.

Member Data Documentation

DtString DtStealthCommand::myStealthCommand

protected

DtString DtStealthCommand::myDisplayName

protected

std::vector<std::string> DtStealthCommand::myVariables

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/stealthCommand.h