| 
    HDK
    
   | 
 
#include <childrenView.h>
Public Types | |
| typedef SdfChildrenView < _ChildPolicy, _Predicate, _Adapter >  | This | 
| typedef _Adapter | Adapter | 
| typedef _Predicate | Predicate | 
| typedef _ChildPolicy | ChildPolicy | 
| typedef ChildPolicy::KeyPolicy | KeyPolicy | 
| typedef Sdf_Children< ChildPolicy > | ChildrenType | 
| typedef ChildPolicy::KeyType | key_type | 
| typedef Adapter::PublicType | value_type | 
| typedef Sdf_ChildrenViewTraits < This, _InnerIterator, Predicate >  | _Traits | 
| typedef _Traits::const_iterator | const_iterator | 
| typedef  Tf_ProxyReferenceReverseIterator < const_iterator >  | const_reverse_iterator | 
| typedef size_t | size_type | 
| typedef ptrdiff_t | difference_type | 
Public Member Functions | |
| SdfChildrenView () | |
| SdfChildrenView (const SdfLayerHandle &layer, const SdfPath &path, const TfToken &childrenKey, const KeyPolicy &keyPolicy=KeyPolicy()) | |
| SdfChildrenView (const SdfLayerHandle &layer, const SdfPath &path, const TfToken &childrenKey, const Predicate &predicate, const KeyPolicy &keyPolicy=KeyPolicy()) | |
| SdfChildrenView (const SdfChildrenView &other) | |
| template<class OtherAdapter > | |
| SdfChildrenView (const SdfChildrenView< ChildPolicy, Predicate, OtherAdapter > &other) | |
| ~SdfChildrenView () | |
| SdfChildrenView & | operator= (const SdfChildrenView &other) | 
| const_iterator | begin () const | 
| Returns an const_iterator pointing to the beginning of the vector.  More... | |
| const_iterator | end () const | 
| Returns an const_iterator pointing to the end of the vector.  More... | |
| const_reverse_iterator | rbegin () const | 
| const_reverse_iterator | rend () const | 
| size_type | size () const | 
| Returns the size of the vector.  More... | |
| bool | empty () const | 
Returns true if the vector is empty.  More... | |
| value_type | operator[] (size_type n) const | 
Returns the n'th element.  More... | |
| value_type | front () const | 
| Returns the first element.  More... | |
| value_type | back () const | 
| Returns the last element.  More... | |
| const_iterator | find (const key_type &x) const | 
Finds the element with key x.  More... | |
| const_iterator | find (const value_type &x) const | 
Finds element x, if present in this view.  More... | |
| key_type | key (const const_iterator &x) const | 
| Returns the key for an element.  More... | |
| key_type | key (const value_type &x) const | 
| Returns the key for a value.  More... | |
| std::vector< value_type > | values () const | 
| Returns the elements, in order.  More... | |
| template<typename V > | |
| V | values_as () const | 
| Returns the elements, in order.  More... | |
| std::vector< key_type > | keys () const | 
| Returns the keys for all elements, in order.  More... | |
| template<typename V > | |
| V | keys_as () const | 
| Returns the keys for all elements, in order.  More... | |
| template<typename Dict > | |
| Dict | items_as () const | 
| Returns the elements as a dictionary.  More... | |
| bool | has (const key_type &x) const | 
Returns true if an element with key x is in the container.  More... | |
| bool | has (const value_type &x) const | 
| size_type | count (const key_type &x) const | 
Returns the number of elements with key x in the container.  More... | |
| value_type | get (const key_type &x) const | 
| value_type | get (const key_type &x, const value_type &fallback) const | 
| value_type | operator[] (const key_type &x) const | 
| bool | operator== (const This &other) const | 
| bool | operator!= (const This &other) const | 
| bool | IsValid () const | 
| ChildrenType & | GetChildren () | 
| const Predicate & | GetPredicate () const | 
Friends | |
| template<class V , class P , class A > | |
| class | SdfChildrenView | 
Provides a view onto an object's children.
The _ChildPolicy dictates the type of children being viewed by this object. This policy defines the key type by which children are referenced (e.g. a TfToken, or an SdfPath) and the value type of the children objects.
The _Predicate takes a value type argument and returns true if the object should be included in the view and false otherwise.
The _Adapter allows the view to present the children objects as a different type. The _Adapter class must provide functions to convert the children object type defined by _ChildPolicy to the desired public type and vice-versa. See SdfChildrenViewTrivialAdapter for an example. By default, the view presents children objects as the value type defined in _ChildPolicy.
Note that all methods are const, i.e. the children cannot be changed through a view.
Definition at line 205 of file childrenView.h.
| typedef Sdf_ChildrenViewTraits<This, _InnerIterator, Predicate> SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::_Traits | 
Definition at line 364 of file childrenView.h.
| typedef _Adapter SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::Adapter | 
Definition at line 209 of file childrenView.h.
| typedef _ChildPolicy SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::ChildPolicy | 
Definition at line 211 of file childrenView.h.
| typedef Sdf_Children<ChildPolicy> SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::ChildrenType | 
Definition at line 213 of file childrenView.h.
| typedef _Traits::const_iterator SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::const_iterator | 
Definition at line 365 of file childrenView.h.
| typedef Tf_ProxyReferenceReverseIterator<const_iterator> SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::const_reverse_iterator | 
Definition at line 366 of file childrenView.h.
| typedef ptrdiff_t SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::difference_type | 
Definition at line 368 of file childrenView.h.
| typedef ChildPolicy::KeyType SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::key_type | 
Definition at line 215 of file childrenView.h.
| typedef ChildPolicy::KeyPolicy SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::KeyPolicy | 
Definition at line 212 of file childrenView.h.
| typedef _Predicate SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::Predicate | 
Definition at line 210 of file childrenView.h.
| typedef size_t SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::size_type | 
Definition at line 367 of file childrenView.h.
| typedef SdfChildrenView<_ChildPolicy, _Predicate, _Adapter> SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::This | 
Definition at line 207 of file childrenView.h.
| typedef Adapter::PublicType SdfChildrenView< _ChildPolicy, _Predicate, _Adapter >::value_type | 
Definition at line 216 of file childrenView.h.
      
  | 
  inline | 
Definition at line 370 of file childrenView.h.
      
  | 
  inline | 
Definition at line 374 of file childrenView.h.
      
  | 
  inline | 
Definition at line 381 of file childrenView.h.
      
  | 
  inline | 
Definition at line 390 of file childrenView.h.
      
  | 
  inline | 
Definition at line 397 of file childrenView.h.
      
  | 
  inline | 
Definition at line 404 of file childrenView.h.
      
  | 
  inline | 
Returns the last element.
Definition at line 462 of file childrenView.h.
      
  | 
  inline | 
Returns an const_iterator pointing to the beginning of the vector.
Definition at line 416 of file childrenView.h.
      
  | 
  inline | 
Returns the number of elements with key x in the container. 
Definition at line 547 of file childrenView.h.
      
  | 
  inline | 
Returns true if the vector is empty. 
Definition at line 445 of file childrenView.h.
      
  | 
  inline | 
Returns an const_iterator pointing to the end of the vector.
Definition at line 422 of file childrenView.h.
      
  | 
  inline | 
Finds the element with key x. 
Definition at line 467 of file childrenView.h.
      
  | 
  inline | 
Finds element x, if present in this view. 
Definition at line 480 of file childrenView.h.
      
  | 
  inline | 
Returns the first element.
Definition at line 457 of file childrenView.h.
      
  | 
  inline | 
Returns the element with key x or a default constructed value if no such element exists. 
Definition at line 553 of file childrenView.h.
      
  | 
  inline | 
Returns the element with key x or the fallback if no such element exists. 
Definition at line 563 of file childrenView.h.
      
  | 
  inline | 
Definition at line 596 of file childrenView.h.
      
  | 
  inline | 
Definition at line 601 of file childrenView.h.
      
  | 
  inline | 
Returns true if an element with key x is in the container. 
Definition at line 536 of file childrenView.h.
      
  | 
  inline | 
Returns true if an element with the same key as x is in the container. 
Definition at line 542 of file childrenView.h.
      
  | 
  inline | 
Definition at line 591 of file childrenView.h.
      
  | 
  inline | 
Returns the elements as a dictionary.
Definition at line 527 of file childrenView.h.
      
  | 
  inline | 
Returns the key for an element.
Definition at line 486 of file childrenView.h.
      
  | 
  inline | 
Returns the key for a value.
Definition at line 491 of file childrenView.h.
      
  | 
  inline | 
Returns the keys for all elements, in order.
Definition at line 509 of file childrenView.h.
      
  | 
  inline | 
Returns the keys for all elements, in order.
Definition at line 520 of file childrenView.h.
      
  | 
  inline | 
Compares children for inequality. Children are not equal if list edits are not identical or the keys don't contain the same elements.
Definition at line 586 of file childrenView.h.
      
  | 
  inline | 
Definition at line 408 of file childrenView.h.
      
  | 
  inline | 
Compares children for equality. Children are equal if the list edits are identical and the keys contain the same elements.
Definition at line 579 of file childrenView.h.
      
  | 
  inline | 
Returns the n'th element. 
Definition at line 450 of file childrenView.h.
      
  | 
  inline | 
Returns the element with key x or a default constructed value if no such element exists. 
Definition at line 573 of file childrenView.h.
      
  | 
  inline | 
Returns an const_reverse_iterator pointing to the beginning of the reversed vector.
Definition at line 429 of file childrenView.h.
      
  | 
  inline | 
Returns an const_reverse_iterator pointing to the end of the reversed vector.
Definition at line 435 of file childrenView.h.
      
  | 
  inline | 
Returns the size of the vector.
Definition at line 440 of file childrenView.h.
      
  | 
  inline | 
Returns the elements, in order.
Definition at line 496 of file childrenView.h.
      
  | 
  inline | 
Returns the elements, in order.
Definition at line 502 of file childrenView.h.
      
  | 
  friend | 
Definition at line 617 of file childrenView.h.