SdfListOp< T > Class Template Reference

Value type representing a list-edit operation. More...

Public Types

typedef T ItemType
 
typedef std::vector< ItemType > ItemVector
 
typedef ItemType value_type
 
typedef ItemVector value_vector_type
 
typedef std::function< boost::optional< ItemType >SdfListOpType, const ItemType &) > ApplyCallback
 Callback type for ApplyOperations. More...
 
typedef std::function< boost::optional< ItemType >const ItemType &) > ModifyCallback
 Callback type for ModifyOperations. More...
 

Public Member Functions

SDF_API SdfListOp ()
 Create an empty ListOp in non-explicit mode. More...
 
SDF_API void Swap (SdfListOp< T > &rhs)
 
bool HasKeys () const
 Returns true if the editor has an explicit list (even if it's empty) or it has any added, prepended, appended, deleted, or ordered keys. More...
 
SDF_API bool HasItem (const T &item) const
 Returns true if the given item is in any of the item lists. More...
 
bool IsExplicit () const
 Returns true if the list is explicit. More...
 
const ItemVector & GetExplicitItems () const
 Returns the explicit items. More...
 
const ItemVector & GetAddedItems () const
 Returns the explicit items. More...
 
const ItemVector & GetPrependedItems () const
 Returns the explicit items. More...
 
const ItemVector & GetAppendedItems () const
 Returns the explicit items. More...
 
const ItemVector & GetDeletedItems () const
 Returns the deleted items. More...
 
const ItemVector & GetOrderedItems () const
 Returns the ordered items. More...
 
SDF_API const ItemVector & GetItems (SdfListOpType type) const
 Return the item vector identified by type. More...
 
SDF_API void SetExplicitItems (const ItemVector &items)
 
SDF_API void SetAddedItems (const ItemVector &items)
 
SDF_API void SetPrependedItems (const ItemVector &items)
 
SDF_API void SetAppendedItems (const ItemVector &items)
 
SDF_API void SetDeletedItems (const ItemVector &items)
 
SDF_API void SetOrderedItems (const ItemVector &items)
 
SDF_API void SetItems (const ItemVector &items, SdfListOpType type)
 Sets the item vector for the given operation type. More...
 
SDF_API void Clear ()
 Removes all items and changes the list to be non-explicit. More...
 
SDF_API void ClearAndMakeExplicit ()
 Removes all items and changes the list to be explicit. More...
 
SDF_API void ApplyOperations (ItemVector *vec, const ApplyCallback &cb=ApplyCallback()) const
 Applies edit operations to the given ItemVector. More...
 
SDF_API boost::optional< SdfListOp< T > > ApplyOperations (const SdfListOp< T > &inner) const
 Applies edit operations to the given ListOp. More...
 
SDF_API bool ModifyOperations (const ModifyCallback &callback)
 Modifies operations specified in this object. More...
 
SDF_API bool ReplaceOperations (const SdfListOpType op, size_t index, size_t n, const ItemVector &newItems)
 Replaces the items in the specified operation vector in the range (index, index + n] with the given newItems. More...
 
SDF_API void ComposeOperations (const SdfListOp< T > &stronger, SdfListOpType op)
 Composes a stronger SdfListOp's opinions for a given operation list over this one. More...
 
bool operator== (const SdfListOp< T > &rhs) const
 
bool operator!= (const SdfListOp< T > &rhs) const
 

Static Public Member Functions

static SDF_API SdfListOp CreateExplicit (const ItemVector &explicitItems=ItemVector())
 Create a ListOp in explicit mode with the given explicitItems. More...
 
static SDF_API SdfListOp Create (const ItemVector &prependedItems=ItemVector(), const ItemVector &appendedItems=ItemVector(), const ItemVector &deletedItems=ItemVector())
 Create a ListOp in non-explicit mode with the given prependedItems, appendedItems, and deletedItems. More...
 

Friends

size_t hash_value (const SdfListOp &op)
 

Detailed Description

template<typename T>
class SdfListOp< T >

Value type representing a list-edit operation.

SdfListOp is a value type representing an operation that edits a list. It may add or remove items, reorder them, or replace the list entirely.

Definition at line 75 of file listOp.h.

Member Typedef Documentation

◆ ApplyCallback

typedef std::function< boost::optional<ItemType>SdfListOpType, const ItemType&) > ApplyCallback

Callback type for ApplyOperations.

Definition at line 184 of file listOp.h.

◆ ModifyCallback

typedef std::function< boost::optional<ItemType>const ItemType&) > ModifyCallback

Callback type for ModifyOperations.

Definition at line 212 of file listOp.h.

Constructor & Destructor Documentation

◆ SdfListOp()

SDF_API SdfListOp ( )

Create an empty ListOp in non-explicit mode.

Member Function Documentation

◆ ApplyOperations() [1/2]

SDF_API void ApplyOperations ( ItemVector *  vec,
const ApplyCallback cb = ApplyCallback() 
) const

Applies edit operations to the given ItemVector.

If supplied, cb will be called on each item in the operation vectors before they are applied to vec. Consumers can use this to transform the items stored in the operation vectors to match what's stored in vec.

◆ ApplyOperations() [2/2]

SDF_API boost::optional<SdfListOp<T> > ApplyOperations ( const SdfListOp< T > &  inner) const

Applies edit operations to the given ListOp.

The result is a ListOp that, when applied to a list, has the same effect as applying inner and then this in sequence.

The result will be empty if the result is not well defined. The result is well-defined when inner and this do not use the 'ordered' or 'added' item lists. In other words, only the explicit, prepended, appended, and deleted portions of SdfListOp are closed under composition with ApplyOperations().

◆ Clear()

SDF_API void Clear ( )

Removes all items and changes the list to be non-explicit.

◆ ClearAndMakeExplicit()

SDF_API void ClearAndMakeExplicit ( )

Removes all items and changes the list to be explicit.

◆ ComposeOperations()

SDF_API void ComposeOperations ( const SdfListOp< T > &  stronger,
SdfListOpType  op 
)

Composes a stronger SdfListOp's opinions for a given operation list over this one.

◆ Create()

static SDF_API SdfListOp Create ( const ItemVector &  prependedItems = ItemVector(),
const ItemVector &  appendedItems = ItemVector(),
const ItemVector &  deletedItems = ItemVector() 
)
static

Create a ListOp in non-explicit mode with the given prependedItems, appendedItems, and deletedItems.

◆ CreateExplicit()

static SDF_API SdfListOp CreateExplicit ( const ItemVector &  explicitItems = ItemVector())
static

Create a ListOp in explicit mode with the given explicitItems.

◆ GetAddedItems()

const ItemVector& GetAddedItems ( ) const
inline

Returns the explicit items.

Definition at line 133 of file listOp.h.

◆ GetAppendedItems()

const ItemVector& GetAppendedItems ( ) const
inline

Returns the explicit items.

Definition at line 145 of file listOp.h.

◆ GetDeletedItems()

const ItemVector& GetDeletedItems ( ) const
inline

Returns the deleted items.

Definition at line 151 of file listOp.h.

◆ GetExplicitItems()

const ItemVector& GetExplicitItems ( ) const
inline

Returns the explicit items.

Definition at line 127 of file listOp.h.

◆ GetItems()

SDF_API const ItemVector& GetItems ( SdfListOpType  type) const

Return the item vector identified by type.

◆ GetOrderedItems()

const ItemVector& GetOrderedItems ( ) const
inline

Returns the ordered items.

Definition at line 157 of file listOp.h.

◆ GetPrependedItems()

const ItemVector& GetPrependedItems ( ) const
inline

Returns the explicit items.

Definition at line 139 of file listOp.h.

◆ HasItem()

SDF_API bool HasItem ( const T &  item) const

Returns true if the given item is in any of the item lists.

◆ HasKeys()

bool HasKeys ( ) const
inline

Returns true if the editor has an explicit list (even if it's empty) or it has any added, prepended, appended, deleted, or ordered keys.

Definition at line 103 of file listOp.h.

◆ IsExplicit()

bool IsExplicit ( ) const
inline

Returns true if the list is explicit.

Definition at line 121 of file listOp.h.

◆ ModifyOperations()

SDF_API bool ModifyOperations ( const ModifyCallback callback)

Modifies operations specified in this object.

callback is called for every item in all operation vectors. If the returned key is empty then the key is removed, otherwise it's replaced with the returned key.

Returns true if a change was made, false otherwise.

◆ ReplaceOperations()

SDF_API bool ReplaceOperations ( const SdfListOpType  op,
size_t  index,
size_t  n,
const ItemVector &  newItems 
)

Replaces the items in the specified operation vector in the range (index, index + n] with the given newItems.

If newItems is empty the items in the range will simply be removed.

◆ SetItems()

SDF_API void SetItems ( const ItemVector &  items,
SdfListOpType  type 
)

Sets the item vector for the given operation type.


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