X-Plane Remote Access Plugin and Client Library
Public Member Functions | Static Public Member Functions | Public Attributes | Static Private Attributes | List of all members
xplra.ProtocolException Class Reference
Inheritance diagram for xplra.ProtocolException:

Public Member Functions

def __init__ (self, resultCode, parameter=None)
 

Static Public Member Functions

def getMessage (resultCode)
 

Public Attributes

 resultCode
 the result code, one of the RESULT_XXX constants
 
 parameter
 an optional parameter for the result
 

Static Private Attributes

dictionary _message
 mapping from result codes to their string representation More...
 

Detailed Description

Exception to signify protocol errors.

Definition at line 131 of file xplra.py.

Constructor & Destructor Documentation

◆ __init__()

def xplra.ProtocolException.__init__ (   self,
  resultCode,
  parameter = None 
)
Construct the exception.

Definition at line 158 of file xplra.py.

Member Function Documentation

◆ getMessage()

def xplra.ProtocolException.getMessage (   resultCode)
static
Get the message for the given result code.

Definition at line 151 of file xplra.py.

Member Data Documentation

◆ _message

dictionary xplra.ProtocolException._message
staticprivate
Initial value:
= { RESULT_INVALID_COMMAND : "invalid command",
RESULT_UNKNOWN_DATAREF : "unknown dataref",
RESULT_INVALID_TYPE : "invalid type",
RESULT_INVALID_LENGTH : "invalid length",
RESULT_INVALID_OFFSET : "invalid offset",
RESULT_INVALID_COUNT : "invalid count",
RESULT_INVALID_ID : "invalid ID",
RESULT_INVALID_DURATION : "invalid duration",
RESULT_OTHER_ERROR : "other error" }

mapping from result codes to their string representation

Definition at line 135 of file xplra.py.


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