orxonox::ConsoleCommand Class Reference

#include <src/core/ConsoleCommand.h>

Inheritance diagram for orxonox::ConsoleCommand:

orxonox::Executor

List of all members.

Public Member Functions

ConsoleCommandaccessLevel (AccessLevel::Value level)
ConsoleCommandargumentCompleter (unsigned int param, ArgumentCompleter *completer)
 ConsoleCommand (Functor *functor, const std::string &name="")
void createArgumentCompletionList (unsigned int param, const std::string &param1="", const std::string &param2="", const std::string &param3="", const std::string &param4="", const std::string &param5="")
ConsoleCommanddefaultValue (unsigned int index, const MultiType &param)
ConsoleCommanddefaultValues (const MultiType &param1, const MultiType &param2, const MultiType &param3, const MultiType &param4, const MultiType &param5)
ConsoleCommanddefaultValues (const MultiType &param1, const MultiType &param2, const MultiType &param3, const MultiType &param4)
ConsoleCommanddefaultValues (const MultiType &param1, const MultiType &param2, const MultiType &param3)
ConsoleCommanddefaultValues (const MultiType &param1, const MultiType &param2)
ConsoleCommanddefaultValues (const MultiType &param1)
ConsoleCommanddescription (const std::string &description)
ConsoleCommanddescriptionParam (int param, const std::string &description)
ConsoleCommanddescriptionReturnvalue (const std::string &description)
AccessLevel::Value getAccessLevel () const
ArgumentCompletergetArgumentCompleter (unsigned int param) const
const ArgumentCompletionListgetArgumentCompletionList () const
ArgumentCompletionList::const_iterator getArgumentCompletionListBegin () const
ArgumentCompletionList::const_iterator getArgumentCompletionListEnd () const
int getInputConfiguredParam_ () const
KeybindMode::Value getKeybindMode () const
ConsoleCommandinputConfiguredParam (int index)
ConsoleCommandkeybindMode (KeybindMode::Value mode)
ConsoleCommandsetAsInputCommand ()

Private Attributes

AccessLevel::Value accessLevel_
ArgumentCompleterargumentCompleter_ [5]
ArgumentCompletionList argumentList_
int inputConfiguredParam_
KeybindMode::Value keybindMode_


Constructor & Destructor Documentation

orxonox::ConsoleCommand::ConsoleCommand ( Functor functor,
const std::string name = "" 
)


Member Function Documentation

ConsoleCommand& orxonox::ConsoleCommand::accessLevel ( AccessLevel::Value  level  )  [inline]

ConsoleCommand & orxonox::ConsoleCommand::argumentCompleter ( unsigned int  param,
ArgumentCompleter completer 
)

References argumentCompleter_, and COUT.

void orxonox::ConsoleCommand::createArgumentCompletionList ( unsigned int  param,
const std::string param1 = "",
const std::string param2 = "",
const std::string param3 = "",
const std::string param4 = "",
const std::string param5 = "" 
)

ConsoleCommand& orxonox::ConsoleCommand::defaultValue ( unsigned int  index,
const MultiType param 
) [inline]

ConsoleCommand& orxonox::ConsoleCommand::defaultValues ( const MultiType param1,
const MultiType param2,
const MultiType param3,
const MultiType param4,
const MultiType param5 
) [inline]

ConsoleCommand& orxonox::ConsoleCommand::defaultValues ( const MultiType param1,
const MultiType param2,
const MultiType param3,
const MultiType param4 
) [inline]

ConsoleCommand& orxonox::ConsoleCommand::defaultValues ( const MultiType param1,
const MultiType param2,
const MultiType param3 
) [inline]

ConsoleCommand& orxonox::ConsoleCommand::defaultValues ( const MultiType param1,
const MultiType param2 
) [inline]

ConsoleCommand& orxonox::ConsoleCommand::defaultValues ( const MultiType param1  )  [inline]

ConsoleCommand& orxonox::ConsoleCommand::description ( const std::string description  )  [inline]

ConsoleCommand& orxonox::ConsoleCommand::descriptionParam ( int  param,
const std::string description 
) [inline]

ConsoleCommand& orxonox::ConsoleCommand::descriptionReturnvalue ( const std::string description  )  [inline]

AccessLevel::Value orxonox::ConsoleCommand::getAccessLevel (  )  const [inline]

ArgumentCompleter * orxonox::ConsoleCommand::getArgumentCompleter ( unsigned int  param  )  const

References argumentCompleter_.

const ArgumentCompletionList& orxonox::ConsoleCommand::getArgumentCompletionList (  )  const [inline]

ArgumentCompletionList::const_iterator orxonox::ConsoleCommand::getArgumentCompletionListBegin (  )  const [inline]

ArgumentCompletionList::const_iterator orxonox::ConsoleCommand::getArgumentCompletionListEnd (  )  const [inline]

int orxonox::ConsoleCommand::getInputConfiguredParam_ (  )  const [inline]

Referenced by orxonox::Button::parse().

KeybindMode::Value orxonox::ConsoleCommand::getKeybindMode (  )  const [inline]

Referenced by orxonox::Button::parse().

ConsoleCommand& orxonox::ConsoleCommand::inputConfiguredParam ( int  index  )  [inline]

ConsoleCommand& orxonox::ConsoleCommand::keybindMode ( KeybindMode::Value  mode  )  [inline]

ConsoleCommand& orxonox::ConsoleCommand::setAsInputCommand (  )  [inline]


Member Data Documentation

Referenced by ConsoleCommand().

Referenced by ConsoleCommand().

Referenced by ConsoleCommand().


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

Generated on Tue Jul 28 16:22:25 2009 for Orxonox by  doxygen 1.5.6