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

at::StatusReport_Basic Class Reference

#include <at_status_report_basic.h>

Inheritance diagram for at::StatusReport_Basic:

Inheritance graph
[legend]
Collaboration diagram for at::StatusReport_Basic:

Collaboration graph
[legend]
List of all members.

Public Methods

 StatusReport_Basic ()
 StatusReport_Basic (StatusTypeCode i_typecode, int i_status, const std::string &i_description)
virtual void ReportStatus (StatusTypeCode i_typecode, int i_status, const std::string &i_description)
virtual void ReportStatus (const StatusReport *i_sreport)
virtual void ClearStatus ()
virtual bool GetStatus () const
virtual bool GetStatus (StatusTypeCode &o_typecode, int &o_status, std::string &o_description) const
virtual bool GetStatus (StatusReport *o_srep) const

Public Attributes

StatusTypeCode m_status_type
int m_status_code
std::string m_description

Detailed Description

StatusReport_Basic ia a basic implementation of the StatusReport interface.


Constructor & Destructor Documentation

at::StatusReport_Basic::StatusReport_Basic  
 

at::StatusReport_Basic::StatusReport_Basic StatusTypeCode    i_typecode,
int    i_status,
const std::string &    i_description
 


Member Function Documentation

void at::StatusReport_Basic::ClearStatus   [virtual]
 

ClearStatus is used to clear the status.

Implements at::StatusReport.

bool at::StatusReport_Basic::GetStatus StatusReport   o_srep const [virtual]
 

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

Returns:
true if a status was reported.

Implements at::StatusReport.

bool at::StatusReport_Basic::GetStatus StatusTypeCode   o_typecode,
int &    o_status,
std::string &    o_description
const [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.

Implements at::StatusReport.

bool at::StatusReport_Basic::GetStatus   [virtual]
 

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

Returns:
true if an status was reported.

Implements at::StatusReport.

void at::StatusReport_Basic::ReportStatus const StatusReport   i_sreport [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 

Implements at::StatusReport.

void at::StatusReport_Basic::ReportStatus StatusTypeCode    i_typecode,
int    i_status,
const std::string &    i_description
[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.

Implements at::StatusReport.


Member Data Documentation

std::string at::StatusReport_Basic::m_description
 

int at::StatusReport_Basic::m_status_code
 

StatusTypeCode at::StatusReport_Basic::m_status_type
 


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