Sdf_MapEditor< MapType > Class Template Reference

#include <mapEditor.h>

Public Types
typedef MapType::key_type	key_type
typedef MapType::mapped_type	mapped_type
typedef MapType::value_type	value_type
typedef MapType::iterator	iterator

Public Member Functions
virtual	~Sdf_MapEditor ()
virtual std::string	GetLocation () const =0
virtual SdfSpecHandle	GetOwner () const =0
	Returns owner of the map being edited. More...
virtual bool	IsExpired () const =0
	Returns true if the map being edited is expired, false otherwise. More...
virtual const MapType *	GetData () const =0
	Returns const pointer to map being edited. More...
virtual MapType *	GetData ()=0
Editing Operations
virtual void	Copy (const MapType &other)=0
virtual void	Set (const key_type &key, const mapped_type &other)=0
virtual std::pair< iterator, bool >	Insert (const value_type &value)=0
virtual bool	Erase (const key_type &key)=0
virtual SdfAllowed	IsValidKey (const key_type &key) const =0
virtual SdfAllowed	IsValidValue (const mapped_type &value) const =0

Protected Member Functions
	Sdf_MapEditor ()

Detailed Description

template<class MapType>
class Sdf_MapEditor< MapType >

Interface for private implementations used by SdfMapEditProxy.

Definition at line 44 of file mapEditor.h.

Member Typedef Documentation

template<class MapType >

typedef MapType::iterator Sdf_MapEditor< MapType >::iterator

Definition at line 49 of file mapEditor.h.

template<class MapType >

typedef MapType::key_type Sdf_MapEditor< MapType >::key_type

Definition at line 46 of file mapEditor.h.

template<class MapType >

typedef MapType::mapped_type Sdf_MapEditor< MapType >::mapped_type

Definition at line 47 of file mapEditor.h.

template<class MapType >

typedef MapType::value_type Sdf_MapEditor< MapType >::value_type

Definition at line 48 of file mapEditor.h.

Constructor & Destructor Documentation

template<class MapType >

virtual Sdf_MapEditor< MapType >::~Sdf_MapEditor ( )

virtual

template<class MapType >

Sdf_MapEditor< MapType >::Sdf_MapEditor ( )

protected

Member Function Documentation

template<class MapType >

virtual void Sdf_MapEditor< MapType >::Copy ( const MapType &  other )

pure virtual

template<class MapType >

virtual bool Sdf_MapEditor< MapType >::Erase ( const key_type &  key )

pure virtual

template<class MapType >

virtual const MapType* Sdf_MapEditor< MapType >::GetData ( ) const

pure virtual

Returns const pointer to map being edited.

template<class MapType >

virtual MapType* Sdf_MapEditor< MapType >::GetData ( )

pure virtual

Returns non-const pointer to map being edited. All edits to the map should be done using the editing functions below. This function is primarily here for convenience. Ideally, only the const version of this function would exist.

template<class MapType >

virtual std::string Sdf_MapEditor< MapType >::GetLocation ( ) const

pure virtual

Returns a string describing the location of the map being edited. This is used for debugging and error messages.

template<class MapType >

virtual SdfSpecHandle Sdf_MapEditor< MapType >::GetOwner ( ) const

pure virtual

Returns owner of the map being edited.

template<class MapType >

virtual std::pair<iterator, bool> Sdf_MapEditor< MapType >::Insert ( const value_type &  value )

pure virtual

template<class MapType >

virtual bool Sdf_MapEditor< MapType >::IsExpired ( ) const

pure virtual

Returns true if the map being edited is expired, false otherwise.

template<class MapType >

virtual SdfAllowed Sdf_MapEditor< MapType >::IsValidKey ( const key_type &  key ) const

pure virtual

template<class MapType >

virtual SdfAllowed Sdf_MapEditor< MapType >::IsValidValue ( const mapped_type &  value ) const

pure virtual

template<class MapType >

virtual void Sdf_MapEditor< MapType >::Set ( const key_type &  key, const mapped_type &  other  )

pure virtual

---

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

• pxr/usd/sdf/mapEditor.h