FreeNOS
ShellCommand.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2009 Niek Linnenbank
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #include "ShellCommand.h"
19 
20 ShellCommand::ShellCommand(const char *name, const Size params)
21  : m_name(name)
22  , m_help("")
23  , m_minParams(params)
24 {
25 }
26 
28 {
29 }
30 
31 const char * ShellCommand::getName() const
32 {
33  return m_name;
34 }
35 
36 const char * ShellCommand::getHelp() const
37 {
38  return m_help;
39 }
40 
42 {
43  return m_minParams;
44 }
ShellCommand::getHelp
const char * getHelp() const
Get command help.
Definition: ShellCommand.cpp:36
ShellCommand::ShellCommand
ShellCommand(const char *name, const Size minParams=0)
Constructor.
Definition: ShellCommand.cpp:20
ShellCommand::m_help
const char * m_help
Command help text.
Definition: ShellCommand.h:91
ShellCommand.h
ShellCommand::getName
const char * getName() const
Get command name.
Definition: ShellCommand.cpp:31
Size
unsigned int Size
Any sane size indicator cannot go negative.
Definition: Types.h:128
ShellCommand::~ShellCommand
virtual ~ShellCommand()
Destructor.
Definition: ShellCommand.cpp:27
ShellCommand::getMinimumParams
Size getMinimumParams() const
Get the minimum number of parameters required.
Definition: ShellCommand.cpp:41
ShellCommand::m_minParams
const Size m_minParams
Minimum number of parameters required.
Definition: ShellCommand.h:94
ShellCommand::m_name
const char * m_name
Unique name of the command.
Definition: ShellCommand.h:88