bdld::DatumMutableArrayRef Class Reference

#include <bdld_datum.h>

Detailed Description

This class provides mutable access to a datum array. The users of this class can read from and assign to the individual elements as well as change the length of the array.

See bdld_datum

Public Types
typedef Datum::SizeType	SizeType

Public Member Functions
	DatumMutableArrayRef ()
	DatumMutableArrayRef (Datum *data, SizeType *length, SizeType capacity)
	DatumMutableArrayRef (const DatumMutableArrayRef &original)=default
	~DatumMutableArrayRef ()=default
DatumMutableArrayRef &	operator= (const DatumMutableArrayRef &rhs)=default
void *	allocatedPtr () const
Datum *	data () const
SizeType *	length () const
SizeType	capacity () const

Member Typedef Documentation

SizeType

typedef Datum::SizeType bdld::DatumMutableArrayRef::SizeType

SizeType is an alias for an unsigned integral value, representing the capacity of a datum array.

Constructor & Destructor Documentation

DatumMutableArrayRef() [1/3]

bdld::DatumMutableArrayRef::DatumMutableArrayRef ( )

inline

Create a DatumMutableArrayRef object that refers to no array.

DatumMutableArrayRef() [2/3]

bdld::DatumMutableArrayRef::DatumMutableArrayRef ( Datum *  data, SizeType *  length, SizeType  capacity  )

inline

Create a DatumMutableArrayRef object having the specified data, length, and capacity.

DatumMutableArrayRef() [3/3]

bdld::DatumMutableArrayRef::DatumMutableArrayRef ( const DatumMutableArrayRef &  original )

default

Create a DatumMutableArrayRef having the value of the specified original object.

Note

Note that this method's definition is compiler generated.

~DatumMutableArrayRef()

bdld::DatumMutableArrayRef::~DatumMutableArrayRef ( )

default

Destroy this object.

Note

Note that this method's definition is compiler generated.

Member Function Documentation

allocatedPtr()

void * bdld::DatumMutableArrayRef::allocatedPtr ( ) const

inline

Return pointer to the memory allocated for the array.

capacity()

DatumMutableArrayRef::SizeType bdld::DatumMutableArrayRef::capacity ( ) const

inline

Return the allocated capacity of the array.

data()

Datum * bdld::DatumMutableArrayRef::data ( ) const

inline

Return pointer to the first element of the held array.

length()

DatumMutableArrayRef::SizeType * bdld::DatumMutableArrayRef::length ( ) const

inline

Return pointer to the length of the array.

operator=()

DatumMutableArrayRef & bdld::DatumMutableArrayRef::operator= ( const DatumMutableArrayRef &  rhs )

default

Assign to this object the value of the specified rhs object.

Note

Note that this method's definition is compiler generated.

---

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

• bdld_datum.h