Loading...
Searching...
No Matches
SdfMapEditProxy< T, _ValuePolicy > Class Template Reference

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

#include <mapEditProxy.h>

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 Tf_ProxyReferenceReverseIterator< iterator > reverse_iterator
 
typedef Tf_ProxyReferenceReverseIterator< const_iterator > const_reverse_iterator
 

Public Member Functions

 SdfMapEditProxy (const SdfSpecHandle &owner, const TfToken &field)
 
Thisoperator= (const This &other)
 
template<class U , class UVP >
Thisoperator= (const SdfMapEditProxy< U, UVP > &other)
 
Thisoperator= (const Type &data)
 
 operator Type () const
 Returns a copy of the value.
 
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
 Invalid SdfMapEditProxy objects will compare less to an object of their map type.
 
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
 Comparison operator with another proxy Two invalid proxy objects will compare equal.
 
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.
 
 operator bool () const
 Explicit bool conversion operator.
 

Friends

template<class ProxyT >
class SdfPyWrapMapEditProxy
 
bool operator== (const Type &lhs, const SdfMapEditProxy &rhs)
 
bool operator!= (const Type &lhs, const SdfMapEditProxy &rhs)
 
bool operator< (const Type &lhs, const SdfMapEditProxy &rhs)
 
bool operator> (const Type &lhs, const SdfMapEditProxy &rhs)
 
bool operator<= (const Type &lhs, const SdfMapEditProxy &rhs)
 
bool operator>= (const Type &lhs, const SdfMapEditProxy &rhs)
 

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 118 of file mapEditProxy.h.

Member Typedef Documentation

◆ const_iterator

typedef _Iterator<const This*, const_inner_iterator, const value_type&> const_iterator

Definition at line 365 of file mapEditProxy.h.

◆ const_reference

typedef const value_type& const_reference

Definition at line 360 of file mapEditProxy.h.

◆ const_reverse_iterator

typedef Tf_ProxyReferenceReverseIterator<const_iterator> const_reverse_iterator

Definition at line 367 of file mapEditProxy.h.

◆ difference_type

typedef ptrdiff_t difference_type

Definition at line 362 of file mapEditProxy.h.

◆ iterator

typedef _Iterator<This*, inner_iterator, _PairProxy> iterator

Definition at line 363 of file mapEditProxy.h.

◆ key_type

typedef Type::key_type key_type

Definition at line 123 of file mapEditProxy.h.

◆ mapped_type

typedef Type::mapped_type mapped_type

Definition at line 124 of file mapEditProxy.h.

◆ reference

typedef _ValueProxy reference

Definition at line 359 of file mapEditProxy.h.

◆ reverse_iterator

typedef Tf_ProxyReferenceReverseIterator<iterator> reverse_iterator

Definition at line 366 of file mapEditProxy.h.

◆ size_type

typedef size_t size_type

Definition at line 361 of file mapEditProxy.h.

◆ This

typedef SdfMapEditProxy<Type, ValuePolicy> This

Definition at line 122 of file mapEditProxy.h.

◆ Type

typedef T Type

Definition at line 120 of file mapEditProxy.h.

◆ value_type

typedef Type::value_type value_type

Definition at line 125 of file mapEditProxy.h.

◆ ValuePolicy

typedef _ValuePolicy ValuePolicy

Definition at line 121 of file mapEditProxy.h.

Constructor & Destructor Documentation

◆ SdfMapEditProxy() [1/2]

SdfMapEditProxy ( const SdfSpecHandle &  owner,
const TfToken field 
)
inlineexplicit

Definition at line 369 of file mapEditProxy.h.

◆ SdfMapEditProxy() [2/2]

SdfMapEditProxy ( )
inline

Definition at line 375 of file mapEditProxy.h.

Member Function Documentation

◆ begin() [1/2]

iterator begin ( )
inline

Definition at line 409 of file mapEditProxy.h.

◆ begin() [2/2]

const_iterator begin ( ) const
inline

Definition at line 419 of file mapEditProxy.h.

◆ clear()

void clear ( )
inline

Definition at line 522 of file mapEditProxy.h.

◆ count()

size_type count ( const key_type &  key) const
inline

Definition at line 546 of file mapEditProxy.h.

◆ empty()

bool empty ( ) const
inline

Definition at line 459 of file mapEditProxy.h.

◆ end() [1/2]

iterator end ( )
inline

Definition at line 414 of file mapEditProxy.h.

◆ end() [2/2]

const_iterator end ( ) const
inline

Definition at line 425 of file mapEditProxy.h.

◆ equal_range() [1/2]

std::pair< iterator, iterator > equal_range ( const key_type &  key)
inline

Definition at line 595 of file mapEditProxy.h.

◆ equal_range() [2/2]

std::pair< const_iterator, const_iterator > equal_range ( const key_type &  key) const
inline

Definition at line 610 of file mapEditProxy.h.

◆ erase() [1/3]

size_type erase ( const key_type &  key)
inline

Definition at line 497 of file mapEditProxy.h.

◆ erase() [2/3]

void erase ( iterator  first,
iterator  last 
)
inline

Definition at line 508 of file mapEditProxy.h.

◆ erase() [3/3]

void erase ( iterator  pos)
inline

Definition at line 490 of file mapEditProxy.h.

◆ find() [1/2]

iterator find ( const key_type &  key)
inline

Definition at line 527 of file mapEditProxy.h.

◆ find() [2/2]

const_iterator find ( const key_type &  key) const
inline

Definition at line 536 of file mapEditProxy.h.

◆ insert() [1/3]

std::pair< iterator, bool > insert ( const value_type &  value)
inline

Definition at line 464 of file mapEditProxy.h.

◆ insert() [2/3]

void insert ( InputIterator  first,
InputIterator  last 
)
inline

Definition at line 475 of file mapEditProxy.h.

◆ insert() [3/3]

iterator insert ( iterator  pos,
const value_type &  value 
)
inline

Definition at line 469 of file mapEditProxy.h.

◆ 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 742 of file mapEditProxy.h.

◆ lower_bound() [1/2]

iterator lower_bound ( const key_type &  key)
inline

Definition at line 555 of file mapEditProxy.h.

◆ lower_bound() [2/2]

const_iterator lower_bound ( const key_type &  key) const
inline

Definition at line 565 of file mapEditProxy.h.

◆ max_size()

size_type max_size ( ) const
inline

Definition at line 454 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 749 of file mapEditProxy.h.

◆ operator Type()

operator Type ( ) const
inline

Returns a copy of the value.

Definition at line 404 of file mapEditProxy.h.

◆ operator!=() [1/2]

bool operator!= ( const SdfMapEditProxy< U, UVP > &  other) const
inline

Definition at line 709 of file mapEditProxy.h.

◆ operator!=() [2/2]

bool operator!= ( const Type &  other) const
inline

Definition at line 639 of file mapEditProxy.h.

◆ operator<() [1/2]

bool operator< ( const SdfMapEditProxy< U, UVP > &  other) const
inline

Definition at line 715 of file mapEditProxy.h.

◆ operator<() [2/2]

bool operator< ( const Type &  other) const
inline

Invalid SdfMapEditProxy objects will compare less to an object of their map type.

Definition at line 656 of file mapEditProxy.h.

◆ operator<=() [1/2]

bool operator<= ( const SdfMapEditProxy< U, UVP > &  other) const
inline

Definition at line 722 of file mapEditProxy.h.

◆ operator<=() [2/2]

bool operator<= ( const Type &  other) const
inline

Definition at line 671 of file mapEditProxy.h.

◆ operator=() [1/3]

This & operator= ( const SdfMapEditProxy< U, UVP > &  other)
inline

Definition at line 389 of file mapEditProxy.h.

◆ operator=() [2/3]

This & operator= ( const This other)
inline

Definition at line 380 of file mapEditProxy.h.

◆ operator=() [3/3]

This & operator= ( const Type &  data)
inline

Definition at line 397 of file mapEditProxy.h.

◆ operator==() [1/2]

bool operator== ( const SdfMapEditProxy< U, UVP > &  other) const
inline

Comparison operator with another proxy Two invalid proxy objects will compare equal.

Definition at line 699 of file mapEditProxy.h.

◆ operator==() [2/2]

bool operator== ( const Type &  other) const
inline

Definition at line 634 of file mapEditProxy.h.

◆ operator>() [1/2]

bool operator> ( const SdfMapEditProxy< U, UVP > &  other) const
inline

Definition at line 729 of file mapEditProxy.h.

◆ operator>() [2/2]

bool operator> ( const Type &  other) const
inline

Definition at line 661 of file mapEditProxy.h.

◆ operator>=() [1/2]

bool operator>= ( const SdfMapEditProxy< U, UVP > &  other) const
inline

Definition at line 735 of file mapEditProxy.h.

◆ operator>=() [2/2]

bool operator>= ( const Type &  other) const
inline

Definition at line 666 of file mapEditProxy.h.

◆ operator[]()

reference operator[] ( const key_type &  key)
inline

Definition at line 625 of file mapEditProxy.h.

◆ rbegin() [1/2]

reverse_iterator rbegin ( )
inline

Definition at line 432 of file mapEditProxy.h.

◆ rbegin() [2/2]

const_reverse_iterator rbegin ( ) const
inline

Definition at line 440 of file mapEditProxy.h.

◆ rend() [1/2]

reverse_iterator rend ( )
inline

Definition at line 436 of file mapEditProxy.h.

◆ rend() [2/2]

const_reverse_iterator rend ( ) const
inline

Definition at line 444 of file mapEditProxy.h.

◆ size()

size_type size ( ) const
inline

Definition at line 449 of file mapEditProxy.h.

◆ upper_bound() [1/2]

iterator upper_bound ( const key_type &  key)
inline

Definition at line 575 of file mapEditProxy.h.

◆ upper_bound() [2/2]

const_iterator upper_bound ( const key_type &  key) const
inline

Definition at line 585 of file mapEditProxy.h.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const Type &  lhs,
const SdfMapEditProxy< T, _ValuePolicy > &  rhs 
)
friend

Definition at line 649 of file mapEditProxy.h.

◆ operator<

bool operator< ( const Type &  lhs,
const SdfMapEditProxy< T, _ValuePolicy > &  rhs 
)
friend

Definition at line 676 of file mapEditProxy.h.

◆ operator<=

bool operator<= ( const Type &  lhs,
const SdfMapEditProxy< T, _ValuePolicy > &  rhs 
)
friend

Definition at line 686 of file mapEditProxy.h.

◆ operator==

bool operator== ( const Type &  lhs,
const SdfMapEditProxy< T, _ValuePolicy > &  rhs 
)
friend

Definition at line 644 of file mapEditProxy.h.

◆ operator>

bool operator> ( const Type &  lhs,
const SdfMapEditProxy< T, _ValuePolicy > &  rhs 
)
friend

Definition at line 681 of file mapEditProxy.h.

◆ operator>=

bool operator>= ( const Type &  lhs,
const SdfMapEditProxy< T, _ValuePolicy > &  rhs 
)
friend

Definition at line 691 of file mapEditProxy.h.

◆ SdfPyWrapMapEditProxy

friend class SdfPyWrapMapEditProxy
friend

Definition at line 1027 of file mapEditProxy.h.


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