osp::Status Class Reference

A simple status class. More...

#include <osp/sdk/device.h>

Public Types
enum	Code {   Code::Success, Code::Unavailable, Code::Unauthenticated, Code::InvalidArgument,   Code::PermissionDenied, Code::Unknown }

Public Member Functions
	Status (Code code, std::string errMsg=std::string())
bool	ok ()
	Check for status ok. More...
Code	statusCode ()
	Return status code. More...
std::string	errorMessage ()
	Return error message. More...

Detailed Description

A simple status class.

Member Enumeration Documentation

Code

enum osp::Status::Code

strong

Enumerator
Success	Success
Unavailable	Ressource unavailable
Unauthenticated	Authentication failed
InvalidArgument	Invalid argument was provided
PermissionDenied	Permission was denied
Unknown	Unknown error

Member Function Documentation

errorMessage()

std::string osp::Status::errorMessage

(

)

Return error message.

Returns

Error message string

ok()

bool osp::Status::ok

(

)

Check for status ok.

Returns

true if status code is Success, false otherwise

statusCode()

Code osp::Status::statusCode

(

)

Return status code.

Returns

Status code

---

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

• sdk/include/osp/sdk/device.h