DynaShellCmdScript Class Reference

Script command. More...

Inheritance diagram for DynaShellCmdScript:

Public Member Functions
void	Exec (DynaShell &shell, int argc, char *argv[])
	Execute script. More...
virtual char *	TabCompletion (DynaShell &shell, const char *sText, size_t uTextLen, int nState, const char *sContext)
	Command tab completion generator. More...
Public Member Functions inherited from DynaShellCmd
	DynaShellCmd (int nArgCntMin=0, int nArgCntMax=0)
	Default constructor.
virtual	~DynaShellCmd ()
	Default destructor.
const char *	GetCmdName ()
	Get dynamixel shell command name. More...
const char *	GetCmdHelpBrief ()
	Get shell command name brief description. More...
virtual void	PrintHelp (int indent=0, int width=80)
	Print command help with the description aligned at the given indentation. More...
int	GetPublishedLevel () const
const char *	GetPublishedName () const
int	SetPublishedInfo (int nLevel, const char *sParent=NULL)
virtual bool	ChkArgCnt (DynaShell &shell, int argc)
	Check that the argument count is within the class (min,max). More...
bool	ChkArgCnt0 (DynaShell &shell, int argc)
	Check that the argument count is zero. More...
bool	ChkArgCntEQ (DynaShell &shell, int argc, int eq)
	Check that the argument count is equal to the required. More...
bool	ChkArgCntGE (DynaShell &shell, int argc, int min)
	Check argument count against minimum required. More...
bool	ChkArgCntLE (DynaShell &shell, int argc, int max)
	Check argument count against maximum allowed. More...
bool	ChkComm (DynaShell &shell)
	Check that Dynamixel communication exists and is open. More...
bool	ChkChain (DynaShell &shell)
	Check that the servo chain exists. More...
bool	ChkChainNotEmpty (DynaShell &shell)
	Check that the servo chain exists and is not empty. More...
bool	ChkChainHasServo (DynaShell &shell, int nServoId)
	Check that the given servo is present in the chain. More...
bool	ChkChainIsMasterServo (DynaShell &shell, int nServoId)
	Check that the given servo is a master. More...
bool	ToInt (DynaShell &shell, const char *sArg, int *pVal)
	Convert command argument to integer. More...
bool	ToUInt (DynaShell &shell, const char *sArg, uint_t *pVal)
	Convert command argument to unsigned integer. More...
bool	ToDouble (DynaShell &shell, const char *sArg, double *pVal)
	Convert command argument to double. More...
bool	ToBool (DynaShell &shell, const char *sArg, bool *pVal)
	Convert command argument to boolean. More...

Additional Inherited Members
Protected Member Functions inherited from DynaShellCmd
virtual void	PrintSynopses (int indent, int width)
	Print synsopses. More...
virtual void	PrintBlock (int col, int indent, int width, const char *sText)
	Print a block of indented text of width. More...
virtual void	PrintDelim (int width, const char cDelim)
char *	eow (const char *s)
	Find end of word. More...
Protected Attributes inherited from DynaShellCmd
const char *	m_sCmdName
	command name
const char *	m_sCmdHelpBrief
	command help brief
const char *	m_sCmdHelpArgs
	command help arguments
const char *	m_sCmdHelpDesc
	command help description
const int	m_nArgCntMin
	minimum argument count
const int	m_nArgCntMax
	maximum argument count (0 if not max)
int	m_nPubLevel
	command's published level (depth)
char *	m_sPubName
	command's published name

Detailed Description

Script command.

Usage: script file

Definition at line 604 of file dynashell_cmd_core.cxx.

Member Function Documentation

void DynaShellCmdScript::Exec ( DynaShell &  shell, int  argc, char *  argv[]  )

inlinevirtual

Execute script.

Parameters

shell	Dynamixel shell.
argc	Command argument count.
argv	Array of arguments.

Implements DynaShellCmd.

Definition at line 627 of file dynashell_cmd_core.cxx.

References DynaShell::Error(), DynaShell::Ok(), DynaShell::ScriptPush(), and TRY.

  {
    char   *sScriptFile;
    FILE   *fp;

    TRY( ChkArgCnt(shell, argc) );

    sScriptFile = argv[0];

    if( access(sScriptFile, F_OK|R_OK) != 0 )
    {
      shell.Error("%s: %s.", sScriptFile, strerror(errno));
    }
    else if( (fp = fopen(sScriptFile, "r")) == NULL )
    {
      shell.Error("%s: %s.", sScriptFile, strerror(errno));
    }
    else
    {
      shell.ScriptPush(sScriptFile, fp);
      shell.Ok();
    }
  }

virtual char* DynaShellCmdScript::TabCompletion ( DynaShell &  shell, const char *  sText, size_t  uTextLen, int  nState, const char *  sContext  )

inlinevirtual

Command tab completion generator.

Completes <script_file>>

Parameters

shell	Dynamixel shell.
sText	Partial text string to complete.
uTextLen	Length of text.
nState	Generator state. If FIRST, then initialize any statics.
sContext	Generator context (i.e. canonical command path).

Returns

If a first/next match is made, return allocated completed match.
Otherwise return NULL.

Reimplemented from DynaShellCmd.

Definition at line 666 of file dynashell_cmd_core.cxx.

References ReadLine::FileCompletionGenerator().

  {
    return ReadLine::FileCompletionGenerator(sText, nState);
  }

---

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

• dynashell/dynashell_cmd_core.cxx