BotSense.BotSenseError
index
/prj/rnr-sdk/botsense/bsPython/modules/BotSense/BotSenseError.py

BotSense Error Classes and Supporting Routines

 
Modules
       
BotSense.BotSenseCore

 
Classes
       
exceptions.Exception(exceptions.BaseException)
BotSenseError

 
class BotSenseError(exceptions.Exception)
    BotSense Exception Class.
 
 
Method resolution order:
BotSenseError
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods defined here:
__init__(self, ecode, emsg=None)
Raise exception.
 
Parameters:
  ecode  - BotSense error code.
  msg    - Exception message string.
__str__(self)
String representation.

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
Functions
       
ChkReturnIsNonNeg(rc, emsg=None)
Check if return is non-negative.
 
Raises a BotSenseError exception if false.
 
Parameters:
  rc    - BotSense return code.
  emsg  - Optional error message string.
ChkReturnIsOk(rc, emsg=None)
Check if return is ok (BsOk).
 
Raises a BotSenseError exception if false.
 
Parameters:
  rc    - BotSense return code.
  emsg  - Optional error message string.
ChkType(obj, T)
Check of oject is an instance of type T.
 
Raises a BotSenseError exception if false.
 
Parameters:
  obj   - Object instance.
  T     - Required type.
StrError(ecode)
Get the error string describing the BotSense error code.
 
The absolute value of the error code is taken prior retrieving the
string. An unknown or out-of-range error code will be mapped to
BS_ECODE_BADEC.
 
Parameters:
  ecode     - BotSense error code.
 
Return:
  The appropriate error code string.