BloombergLP::bdld::DatumMapRef

Read-only view of a map of Datum values keyed by strings.

Synopsis

Declared in <bdld_datum.h>

class DatumMapRef;

Description

This class provides a read-only view to a map of datums (an array of DatumMapEntry objects). It holds the array by a const pointer and an integral size value. It acts as return value for accessors inside the Datum class that return a map of Datum objects. Note that zero-size maps are valid.

Type Aliases

NameDescription
SizeType Unsigned integral type for capacities, key sizes, and string lengths.
const_iterator Const iterator for this map reference.
const_pointer Const pointer to a map entry.
const_reference Const reference to a map entry.
const_reverse_iterator Const reverse iterator for this map reference.
difference_type Iterator difference type for this map reference.
element_type This typedef is an alias for element_type.
iterator Iterator for this map reference.
pointer Pointer to a map entry.
reference Reference to a map entry.
reverse_iterator Reverse iterator for this map reference.
size_type Size type for this map reference.
value_type Value type for this map reference.

Member Functions

NameDescription
DatumMapRef [constructor]Create a read-only view of the specified datum map.
back Return a reference providing non-modifiable access to the last element of the map this reference object represents. The behavior is undefined unless size() > 0.
begin Return an iterator to the first map entry.
cbegin Return an iterator to the first entry of this map.
cend Return an iterator providing non-modifiable access pointing past-the-end of the array this reference object represents.
crbegin Return a reverse iterator to the last entry of this map.
crend Return a reverse iterator providing non-modifiable access pointing past-the-end of the array this reference object represents.
data Return a pointer to the first entry of this map.
empty Return size() == 0.
end Return a past-the-end iterator for this map reference.
find Return a pointer to the datum with the specified key, or null.
front Return a reference to the first entry of this map.
isSorted Return true if underlying map is sorted and false otherwise.
operator[] Return a reference to the map entry at the specified position.
ownsKeys Return true if underlying map owns the keys and false otherwise. Note that false is always returned for zero-sized DatumMapRef.
print Format this object to the specified output stream.
rbegin Return a reverse iterator to the last map entry.
rend Return a past-the-end reverse iterator for this map reference.
size Return a const-pointer to the number of elements of the map this reference object represents.
operator BloombergLP::bslmf::NestedTraitDeclaration<DatumMapRef, HasPrintMethod> DatumMapRef is trivially copyable.

Non-Member Functions

NameDescription
operator!=Return whether lhs and rhs have different values.
operator==Return whether lhs and rhs have the same value.