Edge Class Reference

#include <Traversal.h>

Public Member Functions
	Edge (ElementPtr elemDown, ElementPtr elemConnect, ElementPtr elemUp)
	~Edge ()
bool	operator== (const Edge &rhs) const
bool	operator!= (const Edge &rhs) const
bool	operator< (const Edge &rhs) const
	operator bool () const
ElementPtr	getDownstreamElement () const
	Return the downstream element of the edge. More...
ElementPtr	getConnectingElement () const
	Return the connecting element of the edge, if any. More...
ElementPtr	getUpstreamElement () const
	Return the upstream element of the edge. More...
string	getName () const
	Return the name of this edge, if any. More...

Detailed Description

An edge between two connected Elements, returned during graph traversal.

A valid Edge consists of a downstream element, an upstream element, and optionally a connecting element that binds them. As an example, the edge between two Node elements will contain a connecting element for the Input of the downstream Node.

See Also

Element::traverseGraph

Definition at line 29 of file Traversal.h.

Constructor & Destructor Documentation

Edge::Edge ( ElementPtr  elemDown, ElementPtr  elemConnect, ElementPtr  elemUp  )

inline

Definition at line 32 of file Traversal.h.

Edge::~Edge ( )

inline

Definition at line 38 of file Traversal.h.

Member Function Documentation

ElementPtr Edge::getConnectingElement ( ) const

inline

Return the connecting element of the edge, if any.

Definition at line 64 of file Traversal.h.

ElementPtr Edge::getDownstreamElement ( ) const

inline

Return the downstream element of the edge.

Definition at line 58 of file Traversal.h.

string Edge::getName

(

)

const

Return the name of this edge, if any.

ElementPtr Edge::getUpstreamElement ( ) const

inline

Return the upstream element of the edge.

Definition at line 70 of file Traversal.h.

Edge::operator bool

(

)

const

bool Edge::operator!= ( const Edge &  rhs ) const

inline

Definition at line 46 of file Traversal.h.

bool Edge::operator< ( const Edge &  rhs ) const

inline

Definition at line 50 of file Traversal.h.

bool Edge::operator== ( const Edge &  rhs ) const

inline

Definition at line 40 of file Traversal.h.

---

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

• MaterialXCore/Traversal.h