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

#include <mapEditProxy.h>

Inheritance diagram for SdfMapEditProxy< T, _ValuePolicy >:

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)

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.

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

Member Typedef Documentation

◆ const_iterator

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

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

Definition at line 369 of file mapEditProxy.h.

◆ const_reference

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

const value_type& const_reference

Definition at line 364 of file mapEditProxy.h.

◆ const_reverse_iterator

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

Tf_ProxyReferenceReverseIterator<const_iterator> const_reverse_iterator

Definition at line 371 of file mapEditProxy.h.

◆ difference_type

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

ptrdiff_t difference_type

Definition at line 366 of file mapEditProxy.h.

◆ iterator

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

_Iterator<This*, inner_iterator, _PairProxy> iterator

Definition at line 367 of file mapEditProxy.h.

◆ key_type

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

Type::key_type key_type

Definition at line 127 of file mapEditProxy.h.

◆ mapped_type

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

Type::mapped_type mapped_type

Definition at line 128 of file mapEditProxy.h.

◆ reference

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

_ValueProxy reference

Definition at line 363 of file mapEditProxy.h.

◆ reverse_iterator

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

Tf_ProxyReferenceReverseIterator<iterator> reverse_iterator

Definition at line 370 of file mapEditProxy.h.

◆ size_type

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

size_t size_type

Definition at line 365 of file mapEditProxy.h.

◆ This

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

SdfMapEditProxy<Type, ValuePolicy> This

Definition at line 126 of file mapEditProxy.h.

◆ Type

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

T Type

Definition at line 124 of file mapEditProxy.h.

◆ value_type

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

Type::value_type value_type

Definition at line 129 of file mapEditProxy.h.

◆ ValuePolicy

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

_ValuePolicy ValuePolicy

Definition at line 125 of file mapEditProxy.h.

Constructor & Destructor Documentation

◆ SdfMapEditProxy()

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

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

inlineexplicit

Definition at line 373 of file mapEditProxy.h.

Member Function Documentation

◆ begin() [1/2]

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

iterator begin ( )

inline

Definition at line 417 of file mapEditProxy.h.

◆ begin() [2/2]

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

const_iterator begin ( ) const

inline

Definition at line 427 of file mapEditProxy.h.

◆ clear()

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

void clear ( )

inline

Definition at line 531 of file mapEditProxy.h.

◆ count()

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

size_type count ( const key_type & key ) const

inline

Definition at line 555 of file mapEditProxy.h.

◆ empty()

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

bool empty ( ) const

inline

Definition at line 467 of file mapEditProxy.h.

◆ end() [1/2]

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

iterator end ( )

inline

Definition at line 422 of file mapEditProxy.h.

◆ end() [2/2]

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

const_iterator end ( ) const

inline

Definition at line 433 of file mapEditProxy.h.

◆ equal_range() [1/2]

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

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

inline

Definition at line 604 of file mapEditProxy.h.

◆ equal_range() [2/2]

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

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

inline

Definition at line 619 of file mapEditProxy.h.

◆ erase() [1/3]

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

size_type erase ( const key_type & key )

inline

Definition at line 505 of file mapEditProxy.h.

◆ erase() [2/3]

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

void erase	(	iterator	first,
		iterator	last )

inline

Definition at line 517 of file mapEditProxy.h.

◆ erase() [3/3]

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

void erase ( iterator pos )

inline

Definition at line 498 of file mapEditProxy.h.

◆ find() [1/2]

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

iterator find ( const key_type & key )

inline

Definition at line 536 of file mapEditProxy.h.

◆ find() [2/2]

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

const_iterator find ( const key_type & key ) const

inline

Definition at line 545 of file mapEditProxy.h.

◆ insert() [1/3]

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

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

inline

Definition at line 472 of file mapEditProxy.h.

◆ insert() [2/3]

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

template<class InputIterator >

void insert	(	InputIterator	first,
		InputIterator	last )

inline

Definition at line 483 of file mapEditProxy.h.

◆ insert() [3/3]

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

iterator insert	(	iterator	pos,
		const value_type &	value )

inline

Definition at line 477 of file mapEditProxy.h.

◆ IsExpired()

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

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

◆ lower_bound() [1/2]

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

iterator lower_bound ( const key_type & key )

inline

Definition at line 564 of file mapEditProxy.h.

◆ lower_bound() [2/2]

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

const_iterator lower_bound ( const key_type & key ) const

inline

Definition at line 574 of file mapEditProxy.h.

◆ max_size()

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

size_type max_size ( ) const

inline

Definition at line 462 of file mapEditProxy.h.

◆ operator bool()

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

operator bool ( ) const

inlineexplicit

Explicit bool conversion operator.

Returns true if the value is valid, false otherwise.

Definition at line 758 of file mapEditProxy.h.

◆ operator Type()

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

operator Type ( ) const

inline

Returns a copy of the value.

Definition at line 412 of file mapEditProxy.h.

◆ operator!=() [1/2]

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

template<class U , class UVP >

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

inline

Definition at line 718 of file mapEditProxy.h.

◆ operator!=() [2/2]

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

bool operator!= ( const Type & other ) const

inline

Definition at line 648 of file mapEditProxy.h.

◆ operator<() [1/2]

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

template<class U , class UVP >

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

inline

Definition at line 724 of file mapEditProxy.h.

◆ operator<() [2/2]

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

bool operator< ( const Type & other ) const

inline

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

Definition at line 665 of file mapEditProxy.h.

◆ operator<=() [1/2]

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

template<class U , class UVP >

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

inline

Definition at line 731 of file mapEditProxy.h.

◆ operator<=() [2/2]

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

bool operator<= ( const Type & other ) const

inline

Definition at line 680 of file mapEditProxy.h.

◆ operator=() [1/3]

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

template<class U , class UVP >

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

inline

Definition at line 397 of file mapEditProxy.h.

◆ operator=() [2/3]

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

This & operator= ( const This & other )

inline

Definition at line 388 of file mapEditProxy.h.

◆ operator=() [3/3]

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

This & operator= ( const Type & data )

inline

Definition at line 405 of file mapEditProxy.h.

◆ operator==() [1/2]

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

template<class U , class UVP >

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

inline

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

Definition at line 708 of file mapEditProxy.h.

◆ operator==() [2/2]

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

bool operator== ( const Type & other ) const

inline

Definition at line 643 of file mapEditProxy.h.

◆ operator>() [1/2]

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

template<class U , class UVP >

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

inline

Definition at line 738 of file mapEditProxy.h.

◆ operator>() [2/2]

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

bool operator> ( const Type & other ) const

inline

Definition at line 670 of file mapEditProxy.h.

◆ operator>=() [1/2]

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

template<class U , class UVP >

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

inline

Definition at line 744 of file mapEditProxy.h.

◆ operator>=() [2/2]

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

bool operator>= ( const Type & other ) const

inline

Definition at line 675 of file mapEditProxy.h.

◆ operator[]()

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

reference operator[] ( const key_type & key )

inline

Definition at line 634 of file mapEditProxy.h.

◆ rbegin() [1/2]

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

reverse_iterator rbegin ( )

inline

Definition at line 440 of file mapEditProxy.h.

◆ rbegin() [2/2]

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

const_reverse_iterator rbegin ( ) const

inline

Definition at line 448 of file mapEditProxy.h.

◆ rend() [1/2]

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

reverse_iterator rend ( )

inline

Definition at line 444 of file mapEditProxy.h.

◆ rend() [2/2]

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

const_reverse_iterator rend ( ) const

inline

Definition at line 452 of file mapEditProxy.h.

◆ size()

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

size_type size ( ) const

inline

Definition at line 457 of file mapEditProxy.h.

◆ upper_bound() [1/2]

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

iterator upper_bound ( const key_type & key )

inline

Definition at line 584 of file mapEditProxy.h.

◆ upper_bound() [2/2]

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

const_iterator upper_bound ( const key_type & key ) const

inline

Definition at line 594 of file mapEditProxy.h.

Friends And Related Symbol Documentation

◆ operator!=

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

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

friend

Definition at line 658 of file mapEditProxy.h.

◆ operator<

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

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

friend

Definition at line 685 of file mapEditProxy.h.

◆ operator<=

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

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

friend

Definition at line 695 of file mapEditProxy.h.

◆ operator==

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

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

friend

Definition at line 653 of file mapEditProxy.h.

◆ operator>

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

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

friend

Definition at line 690 of file mapEditProxy.h.

◆ operator>=

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

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

friend

Definition at line 700 of file mapEditProxy.h.

◆ SdfPyWrapMapEditProxy

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

template<class ProxyT >

friend class SdfPyWrapMapEditProxy

friend

Definition at line 1041 of file mapEditProxy.h.

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

pxr/usd/sdf/mapEditProxy.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ key_type

◆ mapped_type

◆ reference

◆ reverse_iterator

◆ size_type

◆ This

◆ Type

◆ value_type

◆ ValuePolicy

Constructor & Destructor Documentation

◆ SdfMapEditProxy()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ count()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ equal_range() [1/2]

◆ equal_range() [2/2]

◆ erase() [1/3]

◆ erase() [2/3]

◆ erase() [3/3]

◆ find() [1/2]

◆ find() [2/2]

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ IsExpired()

◆ lower_bound() [1/2]

◆ lower_bound() [2/2]

◆ max_size()

◆ operator bool()

◆ operator Type()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator<=() [1/2]

◆ operator<=() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator>() [1/2]

◆ operator>() [2/2]

◆ operator>=() [1/2]

◆ operator>=() [2/2]

◆ operator[]()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ size()

◆ upper_bound() [1/2]

◆ upper_bound() [2/2]

Friends And Related Symbol Documentation

◆ operator!=

◆ operator<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=

◆ SdfPyWrapMapEditProxy