HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
SdfSite Class Reference

#include <site.h>

Public Member Functions

 SdfSite ()
 
 SdfSite (const SdfLayerHandle &layer_, const SdfPath &path_)
 
bool operator== (const SdfSite &other) const
 
bool operator!= (const SdfSite &other) const
 
bool operator< (const SdfSite &other) const
 
bool operator> (const SdfSite &other) const
 
bool operator<= (const SdfSite &other) const
 
bool operator>= (const SdfSite &other) const
 
 operator bool () const
 

Public Attributes

SdfLayerHandle layer
 
SdfPath path
 

Detailed Description

An SdfSite is a simple representation of a location in a layer where opinions may possibly be found. It is simply a pair of layer and path within that layer.

Definition at line 25 of file site.h.

Constructor & Destructor Documentation

SdfSite::SdfSite ( )
inline

Definition at line 28 of file site.h.

SdfSite::SdfSite ( const SdfLayerHandle &  layer_,
const SdfPath &  path_ 
)
inline

Definition at line 29 of file site.h.

Member Function Documentation

SdfSite::operator bool ( ) const
inlineexplicit

Explicit bool conversion operator. A site object converts to true iff both the layer and path fields are filled with valid values, false otherwise. This does NOT imply that there are opinions in the layer at that path.

Definition at line 69 of file site.h.

bool SdfSite::operator!= ( const SdfSite &  other) const
inline

Definition at line 39 of file site.h.

bool SdfSite::operator< ( const SdfSite &  other) const
inline

Definition at line 44 of file site.h.

bool SdfSite::operator<= ( const SdfSite &  other) const
inline

Definition at line 55 of file site.h.

bool SdfSite::operator== ( const SdfSite &  other) const
inline

Definition at line 34 of file site.h.

bool SdfSite::operator> ( const SdfSite &  other) const
inline

Definition at line 50 of file site.h.

bool SdfSite::operator>= ( const SdfSite &  other) const
inline

Definition at line 60 of file site.h.

Member Data Documentation

SdfLayerHandle SdfSite::layer

Definition at line 75 of file site.h.

SdfPath SdfSite::path

Definition at line 76 of file site.h.

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