bit::CData Struct Reference

#include <bit/data.h>

List of all members.

---

Detailed Description

This class represents a constant data block allocated via a smart pointer, hence the name CData as a shortened form of ConstantData.

Additional it provides several typedefs that may be used to ensure type consistency both within the conexus library, and with applications using the conexus library.

Author:

Rick L Vinyard Jr

Public Types
typedef uint8_t	Octet
	Typedefs the concept of an octet as an unsigned 8 bit integer.
typedef boost::shared_array< const Octet >	Octets
	Provides a convenience typedef of a smart pointer to constant data.
Public Member Functions
	CData ()
	Default constructor initializes data size to zero and relies on smart pointer constructor to initialize pointer to NULL.
	CData (const Octet *d, size_t s)
	Constructor which accepts a smart pointer to data and data size in bytes.
	operator const Octet * ()
	Overloaded dereference operator provides direct access to actual data.
Public Attributes
Octets	data
	Smart pointer to the underlying data.
const size_t	size
	Size of the data in bytes.

---

Member Typedef Documentation

bit::CData::Octets

Provides a convenience typedef of a smart pointer to constant data. Hint: access externally as CData::Octets

---

Member Function Documentation

bit::CData::operator const Octet * (   )  [inline]

Overloaded dereference operator provides direct access to actual data. If you want access to the smart pointer, use the data member instead.

---

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

• data.h

---