laelaps_sane.application Class Reference

Laelaps diagnositcs application class. More...

Public Member Functions
def	__init__ (self)
	Constructor.
def	printUsageErr (self, emsg)
	Print usage error. More...
def	printUsage (self)
	Print Command-Line Usage Message. More...
def	getOptions (self, argv=None, kwargs)
	Get command-line options. More...
def	run (self, argv=None, kwargs)
	Run application. More...

Public Attributes
	m_win
	kwargs

Detailed Description

Laelaps diagnositcs application class.

Definition at line 217 of file laelaps_sane.py.

Member Function Documentation

def laelaps_sane.application.getOptions	(		self,
			argv = None,
			kwargs
	)

Get command-line options.

Parameters

	argv	Argument list. If not None, then overrides command-line arguments.
[out]	kwargs	Keyword argument list.

Returns

Parsed keyword arguments.

Definition at line 267 of file laelaps_sane.py.

References laelaps_sane.application._Argv0, laelaps_diag.application._Argv0, laelaps_init.application._Argv0, laelaps_sane.application.printUsage(), laelaps_diag.application.printUsage(), laelaps_init.application.printUsage(), laelaps_sane.application.printUsageErr(), laelaps_diag.application.printUsageErr(), and laelaps_init.application.printUsageErr().

Referenced by laelaps_sane.application.run(), laelaps_speed.application.run(), and laelaps_tune_motors.application.run().

  def getOptions(self, argv=None, **kwargs):
    if argv is None:
      argv = sys.argv

    self._Argv0 = os.path.basename(kwargs.get('argv0', __file__))

    # defaults
    kwargs['debug']  = False
    kwargs['subsys'] = []

    # parse command-line options
    try:
      opts, args = getopt.getopt(argv[1:], "?h",
          ['help', ''])
    except getopt.error, msg:
      raise usage(msg)
    for opt, optarg in opts:
      if opt in ('-h', '--help', '-?'):
        self.printUsage()
        sys.exit(0)

    if len(args) < 1:
      self.printUsageErr("No subsystems specified.")
      sys.exit(128)

    for subsys in args:
      if subsys in SaneSubSys:
        kwargs['subsys'] += [subsys]
      else:
        self.printUsageErr("%s: Unknown/unsupported subsystem." % (subsys))
        sys.exit(128)

    return kwargs

def laelaps_sane.application.printUsage

(

self

)

Print Command-Line Usage Message.

Definition at line 239 of file laelaps_sane.py.

References laelaps_sane.application._Argv0, laelaps_diag.application._Argv0, and laelaps_init.application._Argv0.

Referenced by laelaps_sane.application.getOptions(), laelaps_speed.application.getOptions(), and laelaps_tune_motors.application.getOptions().

  def printUsage(self):
    print \
"""
usage: %s [OPTIONS] SUBSYS [SUBSYS ...]
       %s --help

Laelaps sanity.

Options and arguments:
-h, --help        : Display this help and exit.

SUBSYS            : Laelaps subsystem. One of: motors
                      motors  - Motors and motor controllers

Exit Status:
  On success, 0. An exit status of 128 indicates usage 
  error.
"""  % (self._Argv0, self._Argv0)
 

def laelaps_sane.application.printUsageErr	(		self,
			emsg
	)

Print usage error.

Parameters

emsg	Error message string.

Definition at line 231 of file laelaps_sane.py.

References laelaps_sane.application._Argv0, laelaps_diag.application._Argv0, and laelaps_init.application._Argv0.

Referenced by laelaps_sane.application.getOptions(), and laelaps_speed.application.getOptions().

  def printUsageErr(self, emsg):
    if emsg:
      print "%s: Error: %s" % (self._Argv0, emsg)
    else:
      print "%s: Error" % (self._Argv0)
    print "Try '%s --help' for more information." % (self._Argv0)

def laelaps_sane.application.run	(		self,
			argv = None,
			kwargs
	)

Run application.

Parameters

argv	Optional argument list to override command-line arguments.
kwargs	Optional keyword argument list.

Returns

Exit code.

Definition at line 309 of file laelaps_sane.py.

References laelaps_sane.application.getOptions(), laelaps_diag.application.getOptions(), laelaps_init.application.getOptions(), laelaps_sane.Sanity.kwargs, laelaps_diag.DiagMotors.kwargs, laelaps_sane.application.kwargs, laelaps_diag.DiagToFs.kwargs, laelaps_diag.DiagImu.kwargs, laelaps_diag.DiagWatchdog.kwargs, and laelaps_diag.application.kwargs.

  def run(self, argv=None, **kwargs):
  
    # parse command-line options and arguments
    try:
      self.kwargs = self.getOptions(argv, **kwargs)
    except usage, e:
      print e.msg
      return 128
    
    sane = Sanity(self.kwargs)

    tf = sane.run()

    if tf:
      return 0
    else:
      return 256
      

# ------------------------------------------------------------------------------
# main
# ------------------------------------------------------------------------------

---

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

• sw/scripts/laelaps_sane.py