ConfigCmd Class Reference

A configuration command. More...

#include <ConfigCmd.h>

Collaboration diagram for ConfigCmd:

Public Member Functions
	ConfigCmd (const Ogre::String &name, const Ogre::String &description, const Ogre::String &params_description, ConfigCmdParams params, ConfigCmdCompletion completion)
	Constructor. More...
const Ogre::String &	GetName () const
	Retrieves the command name. More...
const Ogre::String &	GetDescription () const
	Retrieves the command description. More...
const Ogre::String &	GetParamsDescription () const
	Retrieves the command parameter description. More...
ConfigCmdParams	GetHandler () const
	Retrieves the command parameter description. More...
ConfigCmdCompletion	GetCompletion () const
	Checks the command completion. More...

Private Member Functions
	ConfigCmd (const ConfigCmd &rhs)=delete
	Forbidden copy constructor. More...
ConfigCmd &	operator= (const ConfigCmd &rhs)=delete
	Forbidden copy constructor. More...

Private Attributes
Ogre::String	name_
	The command name. More...
Ogre::String	description_
	The command description. More...
Ogre::String	params_description_
	The command parameters description. More...
ConfigCmdParams	params_
	The command parameter handler. More...
ConfigCmdCompletion	completion_
	The command completion. More...

Friends
class	ConfigCmdHandler

Detailed Description

A configuration command.

Constructor & Destructor Documentation

ConfigCmd() [1/2]

ConfigCmd::ConfigCmd	(	const Ogre::String &	name,
		const Ogre::String &	description,
		const Ogre::String &	params_description,
		ConfigCmdParams	params,
		ConfigCmdCompletion	completion
	)

Constructor.

It should only be created only by ConfigCmdManager.

Parameters

[in]	name	Command name.
[in]	description	Command description.
[in]	params_description	Command parameters description.
[in]	params	Command parameter handler.
[in]	completion	Command completion.

ConfigCmd() [2/2]

ConfigCmd::ConfigCmd ( const ConfigCmd &  rhs )

privatedelete

Forbidden copy constructor.

Parameters

[in]

rhs

Command to not copy.

Member Function Documentation

GetCompletion()

ConfigCmdCompletion ConfigCmd::GetCompletion

(

)

const

Checks the command completion.

Returns

The command completion.

GetDescription()

const Ogre::String & ConfigCmd::GetDescription

(

)

const

Retrieves the command description.

Returns

The command description.

GetHandler()

ConfigCmdParams ConfigCmd::GetHandler

(

)

const

Retrieves the command parameter description.

Returns

The command parameter description.

GetName()

const Ogre::String & ConfigCmd::GetName

(

)

const

Retrieves the command name.

Returns

The command name.

GetParamsDescription()

const Ogre::String & ConfigCmd::GetParamsDescription

(

)

const

Retrieves the command parameter description.

Returns

The command parameter description.

operator=()

ConfigCmd & ConfigCmd::operator= ( const ConfigCmd &  rhs )

privatedelete

Forbidden copy constructor.

Parameters

[in]

rhs

Command to not copy.

Friends And Related Function Documentation

ConfigCmdHandler

friend class ConfigCmdHandler

friend

Member Data Documentation

completion_

ConfigCmdCompletion ConfigCmd::completion_

private

The command completion.

description_

Ogre::String ConfigCmd::description_

private

The command description.

name_

Ogre::String ConfigCmd::name_

private

The command name.

params_

ConfigCmdParams ConfigCmd::params_

private

The command parameter handler.

params_description_

Ogre::String ConfigCmd::params_description_

private

The command parameters description.

---

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

• src/core/ConfigCmd.h
• src/core/ConfigCmd.cpp