HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SdfNamespaceEditDetail Struct Reference

#include <namespaceEdit.h>

+ Inheritance diagram for SdfNamespaceEditDetail:

Public Types

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

Public Member Functions

SDF_API SdfNamespaceEditDetail ()
 
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

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.

Constructor & Destructor Documentation

SDF_API SdfNamespaceEditDetail::SdfNamespaceEditDetail ( )
SDF_API SdfNamespaceEditDetail::SdfNamespaceEditDetail ( Result  ,
const SdfNamespaceEdit edit,
const std::string reason 
)

Member Function Documentation

SDF_API bool SdfNamespaceEditDetail::operator== ( const SdfNamespaceEditDetail rhs) const

Member Data Documentation

SdfNamespaceEdit SdfNamespaceEditDetail::edit

The edit.

Definition at line 152 of file namespaceEdit.h.

std::string SdfNamespaceEditDetail::reason

The reason the edit will not succeed cleanly.

Definition at line 153 of file namespaceEdit.h.

Result SdfNamespaceEditDetail::result

Validity.

Definition at line 151 of file namespaceEdit.h.


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