SdfNamespaceEditDetail Struct Reference

Detailed information about a namespace edit. More...

Inherits equality_comparable< SdfNamespaceEditDetail >.

Public Types

enum  Result { Error, Unbatched, Okay }
 Validity of an edit. More...
 

Public Member Functions

SDF_API SdfNamespaceEditDetail (Result, const SdfNamespaceEdit &edit, const std::string &reason)
 
SDF_API bool operator== (const SdfNamespaceEditDetail &rhs) const
 

Public Attributes

Result result
 Validity. More...
 
SdfNamespaceEdit edit
 The edit. More...
 
std::string reason
 The reason the edit will not succeed cleanly. More...
 

Detailed Description

Detailed information about a namespace edit.

Definition at line 134 of file namespaceEdit.h.

Member Enumeration Documentation

◆ Result

enum Result

Validity of an edit.

Enumerator
Error 

Edit will fail.

Unbatched 

Edit will succeed but not batched.

Okay 

Edit will succeed as a batch.

Definition at line 138 of file namespaceEdit.h.

Member Data Documentation

◆ edit

The edit.

Definition at line 152 of file namespaceEdit.h.

◆ reason

std::string reason

The reason the edit will not succeed cleanly.

Definition at line 153 of file namespaceEdit.h.

◆ result

Result result

Validity.

Definition at line 151 of file namespaceEdit.h.


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