HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
Sdf_PathNode Class Reference

#include <pathNode.h>

+ Inheritance diagram for Sdf_PathNode:

Classes

struct  _EqualElement
 
struct  LessThan
 

Public Types

enum  NodeType {
  RootNode, PrimNode, PrimVariantSelectionNode, PrimPropertyNode,
  TargetNode, MapperNode, RelationalAttributeNode, MapperArgNode,
  ExpressionNode, NumNodeTypes
}
 
typedef std::pair< TfToken,
TfToken > 		VariantSelectionType
 

Public Member Functions

NodeType GetNodeType () const
 
Sdf_PathNode const * GetParentNode () const
 
size_t GetElementCount () const
 
bool IsAbsolutePath () const
 
bool IsAbsoluteRoot () const
 
bool ContainsTargetPath () const
 
bool IsNamespaced () const
 
bool ContainsPrimVariantSelection () const
 
const TfToken & GetName () const
 
const SdfPath & GetTargetPath () const
 
const VariantSelectionType & GetVariantSelection () const
 
TfToken GetElement () const
 
void AppendText (std::string *str) const
 
template<class Less >
bool Compare (const Sdf_PathNode &rhs) const
 
unsigned int GetCurrentRefCount () const
 

Static Public Member Functions

static Sdf_PathPrimNodeHandle FindOrCreatePrim (Sdf_PathNode const *parent, const TfToken &name)
 
static Sdf_PathPropNodeHandle FindOrCreatePrimProperty (Sdf_PathNode const *parent, const TfToken &name)
 
static Sdf_PathPrimNodeHandle FindOrCreatePrimVariantSelection (Sdf_PathNode const *parent, const TfToken &variantSet, const TfToken &variant)
 
static Sdf_PathPropNodeHandle FindOrCreateTarget (Sdf_PathNode const *parent, SdfPath const &targetPath)
 
static Sdf_PathPropNodeHandle FindOrCreateRelationalAttribute (Sdf_PathNode const *parent, const TfToken &name)
 
static Sdf_PathPropNodeHandle FindOrCreateMapper (Sdf_PathNode const *parent, SdfPath const &targetPath)
 
static Sdf_PathPropNodeHandle FindOrCreateMapperArg (Sdf_PathNode const *parent, const TfToken &name)
 
static Sdf_PathPropNodeHandle FindOrCreateExpression (Sdf_PathNode const *parent)
 
static Sdf_PathNode const * GetAbsoluteRootNode ()
 
static Sdf_PathNode const * GetRelativeRootNode ()
 
static std::pair< Sdf_PathNode
const *, Sdf_PathNode const * > 		RemoveCommonSuffix (Sdf_PathNode const *a, Sdf_PathNode const *b, bool stopAtRootPrim)
 
static SDF_API const TfToken & GetPathToken (Sdf_PathNode const *primPart, Sdf_PathNode const *propPart)
 
static SDF_API TfToken GetPathAsToken (Sdf_PathNode const *primPart, Sdf_PathNode const *propPart)
 

Protected Member Functions

 Sdf_PathNode (Sdf_PathNode const *parent, NodeType nodeType)
 
 Sdf_PathNode (bool isAbsolute)
 
 ~Sdf_PathNode ()
 
void _Destroy () const
 
SDF_API void _RemovePathTokenFromTable () const
 

Static Protected Member Functions

static TfToken _CreatePathToken (Sdf_PathNode const *primPart, Sdf_PathNode const *propPart)
 

Friends

struct Sdf_PathNodePrivateAccess
 
void intrusive_ptr_add_ref (const Sdf_PathNode *)
 
void intrusive_ptr_release (const Sdf_PathNode *)
 

Detailed Description

Definition at line 61 of file pathNode.h.

Member Typedef Documentation

typedef std::pair<TfToken, TfToken> Sdf_PathNode::VariantSelectionType

Definition at line 190 of file pathNode.h.

Member Enumeration Documentation

enum Sdf_PathNode::NodeType
Enumerator
RootNode 
PrimNode 
PrimVariantSelectionNode 
PrimPropertyNode 
TargetNode 
MapperNode 
RelationalAttributeNode 
MapperArgNode 
ExpressionNode 
NumNodeTypes 

Internal sentinel value.

Definition at line 68 of file pathNode.h.

Constructor & Destructor Documentation

Sdf_PathNode::Sdf_PathNode ( Sdf_PathNode const *  parent,
NodeType  nodeType 
)
inlineprotected

Definition at line 226 of file pathNode.h.

Sdf_PathNode::Sdf_PathNode ( bool  isAbsolute)
explicitprotected
Sdf_PathNode::~Sdf_PathNode ( )
inlineprotected

Definition at line 244 of file pathNode.h.

Member Function Documentation

static TfToken Sdf_PathNode::_CreatePathToken ( Sdf_PathNode const *  primPart,
Sdf_PathNode const *  propPart 
)
staticprotected
void Sdf_PathNode::_Destroy ( ) const
inlineprotected

Definition at line 631 of file pathNode.h.

SDF_API void Sdf_PathNode::_RemovePathTokenFromTable ( ) const
protected
void Sdf_PathNode::AppendText ( std::string *  str) const
template<class Comp >
bool Sdf_PathNode::Compare ( const Sdf_PathNode &  rhs) const
inline

Definition at line 580 of file pathNode.h.

bool Sdf_PathNode::ContainsPrimVariantSelection ( ) const
inline

Definition at line 176 of file pathNode.h.

bool Sdf_PathNode::ContainsTargetPath ( ) const
inline

Definition at line 170 of file pathNode.h.

static Sdf_PathPropNodeHandle Sdf_PathNode::FindOrCreateExpression ( Sdf_PathNode const *  parent)
static
static Sdf_PathPropNodeHandle Sdf_PathNode::FindOrCreateMapper ( Sdf_PathNode const *  parent,
SdfPath const &  targetPath 
)
static
static Sdf_PathPropNodeHandle Sdf_PathNode::FindOrCreateMapperArg ( Sdf_PathNode const *  parent,
const TfToken &  name 
)
static
static Sdf_PathPrimNodeHandle Sdf_PathNode::FindOrCreatePrim ( Sdf_PathNode const *  parent,
const TfToken &  name 
)
static
static Sdf_PathPropNodeHandle Sdf_PathNode::FindOrCreatePrimProperty ( Sdf_PathNode const *  parent,
const TfToken &  name 
)
static
static Sdf_PathPrimNodeHandle Sdf_PathNode::FindOrCreatePrimVariantSelection ( Sdf_PathNode const *  parent,
const TfToken &  variantSet,
const TfToken &  variant 
)
static
static Sdf_PathPropNodeHandle Sdf_PathNode::FindOrCreateRelationalAttribute ( Sdf_PathNode const *  parent,
const TfToken &  name 
)
static
static Sdf_PathPropNodeHandle Sdf_PathNode::FindOrCreateTarget ( Sdf_PathNode const *  parent,
SdfPath const &  targetPath 
)
static
static Sdf_PathNode const* Sdf_PathNode::GetAbsoluteRootNode ( )
static
unsigned int Sdf_PathNode::GetCurrentRefCount ( ) const
inline

Definition at line 223 of file pathNode.h.

TfToken Sdf_PathNode::GetElement ( ) const
inline

Definition at line 705 of file pathNode.h.

size_t Sdf_PathNode::GetElementCount ( ) const
inline

Definition at line 167 of file pathNode.h.

const TfToken & Sdf_PathNode::GetName ( ) const
inline

Definition at line 659 of file pathNode.h.

NodeType Sdf_PathNode::GetNodeType ( ) const
inline

Definition at line 157 of file pathNode.h.

Sdf_PathNode const* Sdf_PathNode::GetParentNode ( ) const
inline

Definition at line 165 of file pathNode.h.

static SDF_API TfToken Sdf_PathNode::GetPathAsToken ( Sdf_PathNode const *  primPart,
Sdf_PathNode const *  propPart 
)
static
static SDF_API const TfToken& Sdf_PathNode::GetPathToken ( Sdf_PathNode const *  primPart,
Sdf_PathNode const *  propPart 
)
static
static Sdf_PathNode const* Sdf_PathNode::GetRelativeRootNode ( )
static
const SdfPath & Sdf_PathNode::GetTargetPath ( ) const
inline

Definition at line 683 of file pathNode.h.

const Sdf_PathNode::VariantSelectionType & Sdf_PathNode::GetVariantSelection ( ) const
inline

Definition at line 696 of file pathNode.h.

bool Sdf_PathNode::IsAbsolutePath ( ) const
inline

Definition at line 168 of file pathNode.h.

bool Sdf_PathNode::IsAbsoluteRoot ( ) const
inline

Definition at line 169 of file pathNode.h.

bool Sdf_PathNode::IsNamespaced ( ) const
inline

Definition at line 171 of file pathNode.h.

static std::pair<Sdf_PathNode const *, Sdf_PathNode const *> Sdf_PathNode::RemoveCommonSuffix ( Sdf_PathNode const *  a,
Sdf_PathNode const *  b,
bool  stopAtRootPrim 
)
static

Friends And Related Function Documentation

void intrusive_ptr_add_ref ( const Sdf_PathNode *  )
friend
void intrusive_ptr_release ( const Sdf_PathNode *  )
friend
friend struct Sdf_PathNodePrivateAccess
friend

Definition at line 268 of file pathNode.h.

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