ErrorInfo Class Reference
[Callback and Event Handling Interfaces]

Failure description class. More...

#include <events.h>

List of all members.

Public Member Functions

void Set (uint16_t subsys, uint16_t code, const char *fmt,...) __attribute__((format(printf
 Set the error description info following a failure.
bool IsSet (void) const
 Query whether a failure description has been set.
void Clear (void)
 Clear any existing failure description.
uint16_t Subsys (void) const
 Query the subsystem ID of the failure.
uint16_t Code (void) const
 Query the code of the failure.
const char * Desc (void) const
 Query the string description of the failure.
bool Matches (uint16_t subsys, uint16_t code)
 Test whether the subsystem and failure ID of the failure match a set of values.

Detailed Description

Failure description class.

Member Function Documentation

void Set ( uint16_t  subsys,
uint16_t  code,
const char *  fmt,

Set the error description info following a failure.

This method fills out an ErrorInfo structure. The structure must be clear at the time this method is invoked. All three elements of the failure description are set via this method.

[in] subsys Subsystem ID code of the fault
[in] code Failure code of the fault
[in] fmt Format string for the descriptive string of the fault
This method may internally allocate memory. If it fails, it will set the fault code to LIBHFP_ERROR_EVENTS_NO_MEMORY.

bool IsSet ( void   )  const [inline]

Query whether a failure description has been set.

true A fault description has been set

false A fault description has not been set and the structure is clear.

The documentation for this class was generated from the following file:
Generated on Fri Jan 9 05:58:39 2009 for libhfp by  doxygen 1.5.4