karoo::datagram_status Class Reference

This class is really just a thread-safe wrapper for enum datagram_status_enum. More...

#include <datagram.h>

List of all members.

Public Member Functions
	datagram_status ()
	Create a default status object, of value DATAGRAM_UNINITIALISED.
	datagram_status (const enum datagram_status_enum ref)
	Create an initialised status object.
	datagram_status (const datagram_status &ref)
	Create an initialised status object.
enum datagram_status_enum	operator= (const datagram_status &ref)
	Set the value of this status object.
enum datagram_status_enum	operator= (enum datagram_status_enum ref)
	Set the value of this status object.
	operator bool () const
	Is the status OK?
	operator enum datagram_status_enum () const
	Get the value of the enumertor.
	operator text () const
	Get a string value, e.g.

---

Detailed Description

This class is really just a thread-safe wrapper for enum datagram_status_enum.

---

Constructor & Destructor Documentation

karoo::datagram_status::datagram_status

(

const enum datagram_status_enum

ref

)

Create an initialised status object.

Parameters:

ref

the enumerated value to initialise it to.

karoo::datagram_status::datagram_status

(

const datagram_status &

ref

)

Create an initialised status object.

Parameters:

ref

the value to initialise it to.

---

Member Function Documentation

karoo::datagram_status::operator bool

(

)

const

Is the status OK?

Returns:

true if the status is DATAGRAM_OK

karoo::datagram_status::operator text

(

)

const

Get a string value, e.g.

DATAGRAM_OK becomes "OK"

enum datagram_status_enum karoo::datagram_status::operator=

(

enum datagram_status_enum

ref

)

Set the value of this status object.

Parameters:

ref

the enumerated value to initialise it to.

enum datagram_status_enum karoo::datagram_status::operator=

(

const datagram_status &

ref

)

Set the value of this status object.

Parameters:

ref

the value to initialise it to.

---

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

• datagram/datagram.h