C++ IP API  9.5.5
TCP & UDP for virtual user scripts
Facilita::BaseResponse Class Reference

The base class of Response classes. More...

Inheritance diagram for Facilita::BaseResponse:

Public Methods

 BaseResponse ()
 Default constructor. More...
 
 BaseResponse (const string &error)
 Constructor, not called directly. More...
 
 BaseResponse (const Exception &error)
 Constructor, not called directly. More...
 
 BaseResponse (const BaseResponse &orig)
 Copy Constructor. More...
 
int code () const
 The numeric value of any error . More...
 
const string & error () const
 
Returns
A string describing the error that has occurred. Empty if no error has occurred
More...
 
bool isError () const
 Has there been an error? More...
 
BaseResponseoperator= (const BaseResponse &other)
 Assignment operator for this class. More...
 

Detailed Description

The base class of Response classes.

Response objects are returned from methods that read from the underlying network. All derived Response classes represent errors in the same way. Response objects can be copied.

Constructors

Facilita::BaseResponse::BaseResponse ( )

Default constructor.

Facilita::BaseResponse::BaseResponse ( const string &  error)

Constructor, not called directly.

Facilita::BaseResponse::BaseResponse ( const Exception &  error)

Constructor, not called directly.

Facilita::BaseResponse::BaseResponse ( const BaseResponse orig)

Copy Constructor.

Methods

int Facilita::BaseResponse::code ( ) const

The numeric value of any error .

If an exception is caught by the method returning this object an Exception code is assigned to the code property.

Returns
The numeric code of any Exception caught else 0.
const string& Facilita::BaseResponse::error ( ) const

Returns
A string describing the error that has occurred. Empty if no error has occurred

bool Facilita::BaseResponse::isError ( ) const

Has there been an error?

Returns
True if there has been an error false otherwise.
BaseResponse& Facilita::BaseResponse::operator= ( const BaseResponse other)

Assignment operator for this class.

Returns
The this object.

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