Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

at::StatusReport Class Reference

#include <at_status_report.h>

Inheritance diagram for at::StatusReport:

Inheritance graph
[legend]
List of all members.

Public Types

enum  StatusTypeCode { NoStatus, ErrorStatus, WarningStatus, UnrecoverableStatus }

Public Methods

virtual ~StatusReport ()
virtual void ReportStatus (StatusTypeCode i_typecode, int i_status, const std::string &i_description)=0
virtual void ReportStatus (const StatusReport *i_sreport)=0
virtual void ClearStatus ()=0
virtual bool GetStatus () const=0
virtual bool GetStatus (StatusTypeCode &i_typecode, int &i_status, std::string &i_description) const=0
virtual bool GetStatus (StatusReport *o_srep) const=0

Detailed Description

StatusReport is a simple status report interface meant to be used as a generic extended form of error/status reporting.


Member Enumeration Documentation

enum at::StatusReport::StatusTypeCode
 

The StatusTypeCode indicates the nature of the status being reported.

Enumeration values:
NoStatus  NoStatus indicates that no status is reported.
ErrorStatus  ErrorStatus is usually used to indicate a failure but not of a nature that causes the system reporting the failure to cease to peform other operations.
WarningStatus  WarningStatus indicates that a problem was encountered but the requested operation was able to complete. It is usually good to log such information but it does not cause unexpected behaviour.
UnrecoverableStatus  UnrecoverableStatus indicates that the error is of a severe nature and the object reporting the status is unable to continue.


Constructor & Destructor Documentation

at::StatusReport::~StatusReport   [virtual]
 


Member Function Documentation

virtual void at::StatusReport::ClearStatus   [pure virtual]
 

ClearStatus is used to clear the status.

Implemented in at::StatusReport_Basic.

virtual bool at::StatusReport::GetStatus StatusReport *    o_srep const [pure virtual]
 

GetStatus( StatusReport * ) is used to get a full description of the status.

Returns:
true if a status was reported.

Implemented in at::StatusReport_Basic.

virtual bool at::StatusReport::GetStatus StatusTypeCode   i_typecode,
int &    i_status,
std::string &    i_description
const [pure virtual]
 

GetStatus( StatusTypeCode &, int &, std::string & ) is used to get a full description of the status.

Parameters:
i_typecode  is a StatusTypeCode.
i_status  is an object specific code.
i_description  describes the status in a human readable form.
Returns:
true if a status was reported.

Implemented in at::StatusReport_Basic.

virtual bool at::StatusReport::GetStatus   [pure virtual]
 

GetStatus is used to get a status report - if any.

Returns:
true if an status was reported.

Implemented in at::StatusReport_Basic.

virtual void at::StatusReport::ReportStatus const StatusReport *    i_sreport [pure virtual]
 

ReportStatus is used by the interface to report the status of a request - usually the act of calling a method on an object. This allows a report from an existing report.

Parameters:
i_sreport 

Implemented in at::StatusReport_Basic.

virtual void at::StatusReport::ReportStatus StatusTypeCode    i_typecode,
int    i_status,
const std::string &    i_description
[pure virtual]
 

ReportStatus is used by the interface to report the status of a request - usually the act of calling a method on an object.

Parameters:
i_typecode  is a StatusTypeCode.
i_status  is an object specific code.
i_description  describes the status in a human readable form.

Implemented in at::StatusReport_Basic.


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

Generated for Austria by doxygen and MakeXS at Sun Oct 24 17:35:34 PDT 2004