HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
mapEditor.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_USD_SDF_MAP_EDITOR_H
25 #define PXR_USD_SDF_MAP_EDITOR_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/sdf/allowed.h"
29 #include "pxr/usd/sdf/spec.h"
30 
31 #include <hboost/noncopyable.hpp>
32 #include <hboost/shared_ptr.hpp>
33 #include <string>
34 #include <utility>
35 
37 
38 class TfToken;
39 
40 /// \class Sdf_MapEditor
41 ///
42 /// Interface for private implementations used by SdfMapEditProxy.
43 ///
44 template <class MapType>
46 public:
47  typedef typename MapType::key_type key_type;
48  typedef typename MapType::mapped_type mapped_type;
49  typedef typename MapType::value_type value_type;
50  typedef typename MapType::iterator iterator;
51 
52  virtual ~Sdf_MapEditor();
53 
54  /// Returns a string describing the location of the map being edited.
55  /// This is used for debugging and error messages.
56  virtual std::string GetLocation() const = 0;
57 
58  /// Returns owner of the map being edited.
59  virtual SdfSpecHandle GetOwner() const = 0;
60 
61  /// Returns true if the map being edited is expired, false otherwise.
62  virtual bool IsExpired() const = 0;
63 
64  /// Returns const pointer to map being edited.
65  virtual const MapType* GetData() const = 0;
66 
67  /// Returns non-const pointer to map being edited.
68  /// All edits to the map should be done using the editing functions below.
69  /// This function is primarily here for convenience. Ideally, only the
70  /// const version of this function would exist.
71  virtual MapType* GetData() = 0;
72 
73  /// \name Editing Operations
74  /// @{
75 
76  virtual void Copy(const MapType& other) = 0;
77  virtual void Set(const key_type& key, const mapped_type& other) = 0;
78  virtual std::pair<iterator, bool> Insert(const value_type& value) = 0;
79  virtual bool Erase(const key_type& key) = 0;
80 
81  virtual SdfAllowed IsValidKey(const key_type& key) const = 0;
82  virtual SdfAllowed IsValidValue(const mapped_type& value) const = 0;
83 
84  /// @}
85 
86 protected:
87  Sdf_MapEditor();
88 
89 };
90 
91 template <class T>
92 hboost::shared_ptr<Sdf_MapEditor<T> >
93 Sdf_CreateMapEditor(const SdfSpecHandle& owner, const TfToken& field);
94 
96 
97 #endif // PXR_USD_SDF_MAP_EDITOR_H
MapType::mapped_type mapped_type
Definition: mapEditor.h:48
virtual SdfSpecHandle GetOwner() const =0
Returns owner of the map being edited.
virtual bool IsExpired() const =0
Returns true if the map being edited is expired, false otherwise.
virtual SdfAllowed IsValidValue(const mapped_type &value) const =0
uint64 value_type
Definition: GA_PrimCompat.h:29
virtual std::pair< iterator, bool > Insert(const value_type &value)=0
virtual ~Sdf_MapEditor()
virtual std::string GetLocation() const =0
MapType::iterator iterator
Definition: mapEditor.h:50
Definition: token.h:87
virtual void Copy(const MapType &other)=0
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
virtual void Set(const key_type &key, const mapped_type &other)=0
virtual const MapType * GetData() const =0
Returns const pointer to map being edited.
virtual SdfAllowed IsValidKey(const key_type &key) const =0
virtual bool Erase(const key_type &key)=0
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
hboost::shared_ptr< Sdf_MapEditor< T > > Sdf_CreateMapEditor(const SdfSpecHandle &owner, const TfToken &field)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: core.h:1131
MapType::value_type value_type
Definition: mapEditor.h:49
MapType::key_type key_type
Definition: mapEditor.h:47