DynaShellCmdBgtStart Class Reference

Start the background thread. More...

Inheritance diagram for DynaShellCmdBgtStart:

Public Member Functions
void	Exec (DynaShell &shell, int argc, char *argv[])
	Execute background thread start. 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...

Protected Member Functions
void	SetTabTDefaults ()
	Set tab completion time period default strings.
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
int	m_nTabIndex
	tab completion: index
string	m_strTDefault
	default time period value
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

Start the background thread.

Definition at line 987 of file dynashell_cmd_if.cxx.

Member Function Documentation

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

inlinevirtual

Execute background thread start.

Parameters

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

Implements DynaShellCmd.

Definition at line 1018 of file dynashell_cmd_if.cxx.

References DynaBgThread::BgThreadStatePaused, DynaBgThread::BgThreadStateReady, DynaBgThread::BgThreadStateRunning, DynaShell::Error(), DynaBgThread::GetCurrentState(), DynaBgThread::getHz(), DynaShell::m_pDynaBgThread, DynaShell::Response(), DynaBgThread::Run(), DynaBgThread::setHz(), and TRY.

  {
    int     i;
    double  val;
    double  fHz;

    TRY( ChkArgCnt(shell, argc) );

    TRY( ChkComm(shell) );
    TRY( ChkChainNotEmpty(shell) );

    switch( shell.m_pDynaBgThread->GetCurrentState() )
    {
      case DynaBgThread::BgThreadStateReady:
      case DynaBgThread::BgThreadStatePaused:
        break;
      case DynaBgThread::BgThreadStateRunning:
      default:
        shell.Error("Background thread already running. "
                    "Try stopping first.");
        return;
    }

    if( argc > 0 )
    {
      TRY( ToDouble(shell, argv[0], &val) );
      fHz = val;
    }
    else
    {
      fHz = shell.m_pDynaBgThread->getHz();
    }

    shell.m_pDynaBgThread->setHz(fHz);

    shell.m_pDynaBgThread->Run();

    shell.Response("Background thread started.\n");
  }

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

inlinevirtual

Command tab completion generator.

Completes t_posctl_dft|notask t_dynamics_dft|notask t_health_dft|notask

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 1073 of file dynashell_cmd_if.cxx.

References ReadLine::dupstr(), ReadLine::FIRST, DynaChain::GetNumberInChain(), DynaShell::m_pDynaChain, and ReadLine::wc().

  {
    int   nArgNum;
    char  buf[16];
  
    if( (shell.m_pDynaChain == NULL) ||
        (shell.m_pDynaChain->GetNumberInChain() == 0) )
    {
      return NULL;
    }
  
    // argument number of already (expanded) arguments
    nArgNum = ReadLine::wc(sContext) - ReadLine::wc(m_sPubName);

    if( nArgNum > m_nArgCntMax )
    {
      return NULL;
    }

    //
    // New command to complete - initialize.
    //
    if( nState == ReadLine::FIRST )
    {
      m_nTabIndex = 0;
    }
  
    // can only expand default keyword
    while( m_nTabIndex < 2 )
    {
      ++m_nTabIndex;

      if( m_nTabIndex == 1 )
      {
        if( !strncmp(m_strTDefault.c_str(), sText, uTextLen) )
        {
          return ReadLine::dupstr(m_strTDefault);
        }
      }
    }
  
    // no more matches
    return NULL;
  }

---

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

• dynashell/dynashell_cmd_if.cxx