epics::pvData::Status Class Reference

Status. More...

#include <misc/pv/status.h>

Inheritance diagram for epics::pvData::Status:

Collaboration diagram for epics::pvData::Status:

Public Types
enum	StatusType { STATUSTYPE_OK, STATUSTYPE_WARNING, STATUSTYPE_ERROR, STATUSTYPE_FATAL }
typedef std::tr1::shared_ptr < Status >	shared_pointer
typedef std::tr1::shared_ptr < const Status >	const_shared_pointer
typedef std::tr1::weak_ptr < Status >	weak_pointer
typedef std::tr1::weak_ptr < const Status >	const_weak_pointer

Public Member Functions
	Status ()
	Status (StatusType type, std::string const &message)
	Status (StatusType type, std::string const &message, std::string const &stackDump)
StatusType	getType () const
const std::string &	getMessage () const
const std::string &	getStackDump () const
bool	isOK () const
bool	isSuccess () const
	operator truth_type () const
void	maximize (const Status &o)
Status &	operator|= (const Status &o)
	short hand for "this->maximize(o)"
void	serialize (ByteBuffer *buffer, SerializableControl *flusher) const
void	deserialize (ByteBuffer *buffer, DeserializableControl *flusher)
void	dump (std::ostream &o) const
Public Member Functions inherited from epics::pvData::Serializable
virtual	~Serializable ()

Static Public Member Functions
static Status	warn (const std::string &m)
static Status	error (const std::string &m)
static Status	fatal (const std::string &m)

Static Public Attributes
static const char *	StatusTypeName []
static Status	Ok

Detailed Description

Status.

This is a class for returning status to clients.

Author

mse

Definition at line 28 of file status.h.

Member Enumeration Documentation

enum epics::pvData::Status::StatusType

Status type enum.

Enumerator
STATUSTYPE_OK	Operation completed successfully.
STATUSTYPE_WARNING	Operation completed successfully, but there is a warning message.
STATUSTYPE_ERROR	Operation failed due to an error.
STATUSTYPE_FATAL	Operation failed due to an unexpected error.

Definition at line 34 of file status.h.

Constructor & Destructor Documentation

epics::pvData::Status::Status ( )

inline

Creates OK status; STATUSTYPE_OK, empty message and stackDump.

Definition at line 56 of file status.h.

epics::pvData::Status::Status	(	StatusType	type,
		std::string const &	message
	)

Create non-OK status.

epics::pvData::Status::Status	(	StatusType	type,
		std::string const &	message,
		std::string const &	stackDump
	)

Create non-OK status.

Member Function Documentation

void epics::pvData::Status::deserialize ( ByteBuffer *  buffer, DeserializableControl *  flusher  )

virtual

Deserialize buffer.

Parameters

buffer	serialization buffer.
flusher	deserialization control.

Implements epics::pvData::Serializable.

const std::string& epics::pvData::Status::getMessage ( ) const

inline

Get error message describing an error. Required if error status.

Returns

error message.

Definition at line 80 of file status.h.

const std::string& epics::pvData::Status::getStackDump ( ) const

inline

Get stack dump where error (exception) happened. Optional.

Returns

stack dump.

Definition at line 86 of file status.h.

StatusType epics::pvData::Status::getType ( ) const

inline

Get status type.

Returns

status type, non-null.

Definition at line 74 of file status.h.

bool epics::pvData::Status::isOK ( ) const

inline

Convenient OK test. Same as (getType() == StatusType.OK). NOTE: this will return false on WARNING message although operation succeeded. To check if operation succeeded, use isSuccess.

Returns

OK status.

See Also

isSuccess()

Definition at line 95 of file status.h.

bool epics::pvData::Status::isSuccess ( ) const

inline

Check if operation succeeded (OK or WARNING).

Returns

operation success status.

Definition at line 103 of file status.h.

void epics::pvData::Status::maximize

(

const Status &

o

)

override this Status if the other has higher StatusType

Status ret;
ret |= call1();
if(ret)
   ret |= call2();
return ret;

void epics::pvData::Status::serialize ( ByteBuffer *  buffer, SerializableControl *  flusher  ) const

virtual

Serialize field into given buffer.

Parameters

buffer	serialization buffer.
flusher	flush interface.

Implements epics::pvData::Serializable.

---

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

• misc/pv/status.h