appkit  1.5.1
RoadNarrows Robotics Application Kit
CmdAddOns.h File Reference

Command line interface command add-ons interface. More...

#include <unistd.h>
#include <stdlib.h>
#include <iostream>
#include <sstream>
#include <string>
#include <vector>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/appkit/CmdDef.h"
#include "rnr/appkit/CommandLine.h"

Go to the source code of this file.

Namespaces

 rnr
 RoadNarrows Robotics.
 
 rnr::cmd
 Commands.
 
 rnr::cmd::addons
 Add-Ons.
 

Enumerations

enum  rnr::cmd::addons::HelpSect {
  rnr::cmd::addons::HelpSectAll,
  rnr::cmd::addons::HelpSectName,
  rnr::cmd::addons::HelpSectBrief,
  rnr::cmd::addons::HelpSectUsage
}
 Command help section identifiers. More...
 

Functions

int rnr::cmd::addons::printCmdHelp (std::ostream &os, const CmdDef &cmddef, const HelpSect section=HelpSectAll)
 Print help for a command convenience function. More...
 
int rnr::cmd::addons::printCmdHelp (std::ostream &os, const CmdDesc &desc, const HelpSect section=HelpSectAll)
 Print help for a command convenience function. More...
 
int rnr::cmd::addons::printCmdHelp (std::ostream &os, const std::string &strName, const std::string &strSyntax, const std::string &strSynopsis, const std::string &strLongDesc, const HelpSect section=HelpSectAll)
 Print help for a command convenience function. More...
 
int rnr::cmd::addons::addHelpCommand (CommandLine &cli, const std::string &strName="help")
 Add the core 'help' command to the command-line interface. More...
 
int rnr::cmd::addons::addQuitCommand (CommandLine &cli, const std::string &strName="quit")
 Add the core 'quit' command to the command-line interface. More...
 
int rnr::cmd::addons::addBtEnableCommand (CommandLine &cli, const std::string &strName="bt")
 Add the core 'bt' command to the command-line interface. More...
 

Detailed Description

Command line interface command add-ons interface.

Author
Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)
Copyright
© 2016-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved
License:
MIT

Definition in file CmdAddOns.h.