Public Types | Public Member Functions | Friends | List of all members
SdfMapEditProxy< T, _ValuePolicy > Class Template Reference

A proxy for editing map-like values. More...

Inherits totally_ordered< SdfMapEditProxy< T, _ValuePolicy >, T >.

Public Types

typedef T Type
 
typedef _ValuePolicy ValuePolicy
 
typedef SdfMapEditProxy< Type, ValuePolicy > This
 
typedef Type::key_type key_type
 
typedef Type::mapped_type mapped_type
 
typedef Type::value_type value_type
 
typedef _ValueProxy reference
 
typedef const value_type & const_reference
 
typedef size_t size_type
 
typedef ptrdiff_t difference_type
 
typedef _Iterator< This *, inner_iterator, _PairProxy > iterator
 
typedef _Iterator< const This *, const_inner_iterator, const value_type & > const_iterator
 
typedef boost::reverse_iterator< iterator > reverse_iterator
 
typedef boost::reverse_iterator< const_iterator > const_reverse_iterator
 

Public Member Functions

 SdfMapEditProxy (const SdfSpecHandle &owner, const TfToken &field)
 
This & operator= (const This &other)
 
template<class U , class UVP >
This & operator= (const SdfMapEditProxy< U, UVP > &other)
 
This & operator= (const Type &data)
 
 operator Type () const
 Returns a copy of the value. More...
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
reverse_iterator rbegin ()
 
reverse_iterator rend ()
 
const_reverse_iterator rbegin () const
 
const_reverse_iterator rend () const
 
size_type size () const
 
size_type max_size () const
 
bool empty () const
 
std::pair< iterator, bool > insert (const value_type &value)
 
iterator insert (iterator pos, const value_type &value)
 
template<class InputIterator >
void insert (InputIterator first, InputIterator last)
 
void erase (iterator pos)
 
size_type erase (const key_type &key)
 
void erase (iterator first, iterator last)
 
void clear ()
 
iterator find (const key_type &key)
 
const_iterator find (const key_type &key) const
 
size_type count (const key_type &key) const
 
iterator lower_bound (const key_type &key)
 
const_iterator lower_bound (const key_type &key) const
 
iterator upper_bound (const key_type &key)
 
const_iterator upper_bound (const key_type &key) const
 
std::pair< iterator, iterator > equal_range (const key_type &key)
 
std::pair< const_iterator, const_iterator > equal_range (const key_type &key) const
 
reference operator[] (const key_type &key)
 
bool operator== (const Type &other) const
 
bool operator< (const Type &other) const
 
bool operator> (const Type &other) const
 
template<class U , class UVP >
bool operator== (const SdfMapEditProxy< U, UVP > &other) const
 
template<class U , class UVP >
bool operator!= (const SdfMapEditProxy< U, UVP > &other) const
 
template<class U , class UVP >
bool operator< (const SdfMapEditProxy< U, UVP > &other) const
 
template<class U , class UVP >
bool operator<= (const SdfMapEditProxy< U, UVP > &other) const
 
template<class U , class UVP >
bool operator> (const SdfMapEditProxy< U, UVP > &other) const
 
template<class U , class UVP >
bool operator>= (const SdfMapEditProxy< U, UVP > &other) const
 
bool IsExpired () const
 Returns true if the value is expired. More...
 
 operator bool () const
 Explicit bool conversion operator. More...
 

Friends

template<class ProxyT >
class SdfPyWrapMapEditProxy
 

Detailed Description

template<class T, class _ValuePolicy = SdfIdentityMapEditProxyValuePolicy<T>>
class SdfMapEditProxy< T, _ValuePolicy >

A proxy for editing map-like values.

A SdfMapEditProxy provides an interface for editing fields containing map-like values. The proxy allows consumers to interact with these values like a typical std::map while taking into account additional editing and validation policies.

The _ValuePolicy is used to canonicalize keys and values before storage or comparison.

See also
SdfIdentityMapEditProxyValuePolicy

Definition at line 120 of file mapEditProxy.h.

Member Function Documentation

◆ IsExpired()

bool IsExpired ( ) const
inline

Returns true if the value is expired.

Note this a default-constructed MapEditProxy is considered to be invalid but not expired.

Definition at line 632 of file mapEditProxy.h.

◆ operator bool()

operator bool ( ) const
inlineexplicit

Explicit bool conversion operator.

Returns true if the value is valid, false otherwise.

Definition at line 639 of file mapEditProxy.h.

◆ operator Type()

operator Type ( ) const
inline

Returns a copy of the value.

Definition at line 346 of file mapEditProxy.h.

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