Mercury2 Hardware Manager  1.0dev
The hardware manager component of the Mercury2 ground station suite.
 All Classes Namespaces Functions Variables Pages
hwm.command.parser.CommandFailed Class Reference

Used to wrap command execution errors. More...

Inheritance diagram for hwm.command.parser.CommandFailed:

Public Member Functions

def __init__
 Sets up the command error. More...
 
def __str__
 

Public Attributes

 message
 
 results
 

Detailed Description

Used to wrap command execution errors.

This exception is raised whenever a command fails to execute. It contains the error response, which specifies details about the error.

Note
To access the error response (what should be sent back to the user), use CommandError.response.

Constructor & Destructor Documentation

def hwm.command.parser.CommandFailed.__init__ (   self,
  error_message,
  error_response 
)

Sets up the command error.

Parameters
error_messageA string describing the error. Normally, the error_response will just be used instead because it contains this string as well as additional details about the error, if there are any.
error_responseA dictionary containing meta-data about the error such as the error message and any additional attributes that may have been passed with it.

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