Dynamixel  2.9.5
RoadNarrows Robotics Dynamixel Package
ShScript Class Reference

Shell Script Class. More...

#include <dynashell.h>

Public Member Functions

 ShScript (const char *sScriptFile, FILE *fp)
 Initialization constructor. More...
 
 ~ShScript ()
 Default destructor.
 
const char * GetScriptName () const
 Get script file name. More...
 
FILE * GetFp ()
 Get file pointer. More...
 
const int GetLineNum () const
 Get current line number. More...
 
void BumpLineNum ()
 Bump line number by one.
 

Protected Attributes

char * m_sScriptFile
 script file name
 
FILE * m_fpScript
 open file pointer
 
int m_nLineNum
 current line number
 

Detailed Description

Shell Script Class.

Definition at line 270 of file dynashell.h.

Constructor & Destructor Documentation

ShScript::ShScript ( const char *  sScriptFile,
FILE *  fp 
)
inline

Initialization constructor.

Parameters
sScripsFileScript file name.
fpOpened file pointer to script file.

Definition at line 279 of file dynashell.h.

References NEWSTR.

280  {
281  m_sScriptFile = NEWSTR(sScriptFile);
282  m_fpScript = fp;
283  m_nLineNum = 0;
284  }
#define NEWSTR(s)
Allocate a new duplicated string convenience macro.
int m_nLineNum
current line number
Definition: dynashell.h:339
FILE * m_fpScript
open file pointer
Definition: dynashell.h:338
char * m_sScriptFile
script file name
Definition: dynashell.h:337

Member Function Documentation

FILE* ShScript::GetFp ( )
inline

Get file pointer.

Returns
FILE*

Definition at line 313 of file dynashell.h.

314  {
315  return m_fpScript;
316  }
FILE * m_fpScript
open file pointer
Definition: dynashell.h:338
const int ShScript::GetLineNum ( ) const
inline

Get current line number.

Returns
int

Definition at line 323 of file dynashell.h.

324  {
325  return m_nLineNum;
326  }
int m_nLineNum
current line number
Definition: dynashell.h:339
const char* ShScript::GetScriptName ( ) const
inline

Get script file name.

Returns
char*

Definition at line 303 of file dynashell.h.

304  {
305  return m_sScriptFile;
306  }
char * m_sScriptFile
script file name
Definition: dynashell.h:337

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