BotSense.BotSenseError Namespace Reference

BotSense Error Classes and Routines. More...

Classes
class	BotSenseError

Functions
def	StrError (ecode)
def	ChkType (obj, T)
def	ChkReturnIsOk (rc, emsg=None)
def	ChkReturnIsNonNeg (rc, emsg=None)

Detailed Description

BotSense Error Classes and Routines.

LastChangedDate

2010-09-13 10:25:05 -0600 (Mon, 13 Sep 2010)

Rev

581

See also

PyDoc Generated Documentation

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2010-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved

Function Documentation

def BotSense.BotSenseError.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.

Definition at line 117 of file BotSenseError.py.

def 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.
  """
  if rc < 0:
    raise BotSenseError(rc, emsg)

def BotSense.BotSenseError.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.

Definition at line 103 of file BotSenseError.py.

def 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.
  """
  if rc != bsCore.BS_OK:
    raise BotSenseError(rc, emsg)

def BotSense.BotSenseError.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.

Definition at line 82 of file BotSenseError.py.

def 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.
  """
  if not isinstance(obj, T):
    if hasattr(T, '__name__'):
      name = T.__name__
    elif hasattr(T, '__class__.__name__'):
      name = T.__class__.__name__
    else:
      name = repr(T)
    raise BotSenseError(bsCore.BS_ECODE_BAD_VAL,
        "Object type is not the '%s' required type." % (name))

def BotSense.BotSenseError.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.

Definition at line 62 of file BotSenseError.py.

Referenced by BotSense.BotSenseError.BotSenseError.__str__().

def 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.
  """
  sErr = bsCore.bsStrError(ecode)
  if not sErr:
    sErr = 'Error'
  return sErr