bdld::DatumMutableMapOwningKeysRef Class Reference

#include <bdld_datum.h>

Detailed Description

This class provides mutable access to a datum key-owning map. The users of this class can assign to the individual elements, copy keys and change the size of the map.

See bdld_datum

Public Types
typedef Datum::SizeType	SizeType

Public Member Functions
	DatumMutableMapOwningKeysRef ()
	DatumMutableMapOwningKeysRef (DatumMapEntry *data, SizeType *size, SizeType allocatedSize, char *keys, bool *sorted)
	DatumMutableMapOwningKeysRef (const DatumMutableMapOwningKeysRef &original)=default
	~DatumMutableMapOwningKeysRef ()=default
DatumMutableMapOwningKeysRef &	operator= (const DatumMutableMapOwningKeysRef &rhs)=default
SizeType	allocatedSize () const
void *	allocatedPtr () const
DatumMapEntry *	data () const
char *	keys () const
SizeType *	size () const
bool *	sorted () const

Member Typedef Documentation

SizeType

typedef Datum::SizeType bdld::DatumMutableMapOwningKeysRef::SizeType

SizeType is an alias for an unsigned integral value, representing the capacity of a datum array, the capacity of a datum map, the capacity of the keys-capacity of a datum-key-owning map or the length of a string.

Constructor & Destructor Documentation

DatumMutableMapOwningKeysRef() [1/3]

bdld::DatumMutableMapOwningKeysRef::DatumMutableMapOwningKeysRef ( )

inline

Create a DatumMutableMapOwningKeysRef object.

DatumMutableMapOwningKeysRef() [2/3]

bdld::DatumMutableMapOwningKeysRef::DatumMutableMapOwningKeysRef ( DatumMapEntry *  data, SizeType *  size, SizeType  allocatedSize, char *  keys, bool *  sorted  )

inline

Create a DatumMutableMapOwningKeysRef object having the specified data, size, allocatedSize, keys, and sorted.

DatumMutableMapOwningKeysRef() [3/3]

bdld::DatumMutableMapOwningKeysRef::DatumMutableMapOwningKeysRef ( const DatumMutableMapOwningKeysRef &  original )

default

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

~DatumMutableMapOwningKeysRef()

bdld::DatumMutableMapOwningKeysRef::~DatumMutableMapOwningKeysRef ( )

default

Destroy this object.

Member Function Documentation

allocatedPtr()

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

inline

Return pointer to the memory allocated for the map.

allocatedSize()

DatumMutableMapOwningKeysRef::SizeType bdld::DatumMutableMapOwningKeysRef::allocatedSize ( ) const

inline

Return the number of bytes allocated for the map.

data()

DatumMapEntry * bdld::DatumMutableMapOwningKeysRef::data ( ) const

inline

Return pointer to the first element in the held map.

keys()

char * bdld::DatumMutableMapOwningKeysRef::keys ( ) const

inline

Return pointer to the start of the buffer where keys are stored.

operator=()

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

default

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

Note

Note that this method's definition is compiler generated.

size()

DatumMutableMapOwningKeysRef::SizeType * bdld::DatumMutableMapOwningKeysRef::size ( ) const

inline

Return pointer to the location where the (held) map's size is stored.

sorted()

bool * bdld::DatumMutableMapOwningKeysRef::sorted ( ) const

inline

Return pointer to the location where the (held) map's sorted flag is stored.

---

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

• bdld_datum.h