CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdDbEvalEdgeInfo Class Reference

#include <DbEvalGraph.h>

Public Member Functions

 OdDbEvalEdgeInfo ()
 
 OdDbEvalEdgeInfo (OdDbEvalNodeId fromId, OdDbEvalNodeId toId, long flags, unsigned long count)
 
OdDbEvalNodeId from () const
 
OdDbEvalNodeId to () const
 
unsigned long refCount () const
 
bool isInvertible () const
 
bool isSuppressed () const
 
bool operator== (const OdDbEvalEdgeInfo &other) const
 

Detailed Description

This class holds the directed edge information between pairs of nodes in an OdDbEvalGraph instance.

Corresponding C++ library: TD_DynBlocks <group OdDb_Classes>

See also
OdDbEvalConnectable OdDbEvalContext OdDbEvalContextIterator OdDbEvalContextPair OdDbEvalExpr OdDbEvalGraph

Definition at line 479 of file DbEvalGraph.h.

Constructor & Destructor Documentation

◆ OdDbEvalEdgeInfo() [1/2]

OdDbEvalEdgeInfo::OdDbEvalEdgeInfo ( )
inline

Definition at line 482 of file DbEvalGraph.h.

◆ OdDbEvalEdgeInfo() [2/2]

OdDbEvalEdgeInfo::OdDbEvalEdgeInfo ( OdDbEvalNodeId  fromId,
OdDbEvalNodeId  toId,
long  flags,
unsigned long  count 
)
inline
Parameters
fromId[in] Node Id of the "from" Node object sharing the edge.
toId[in] Node Id of the "to" Node object sharing the edge.
flags[in] For internal use only.
count[in] Number of times this edge was added to the graph.

Definition at line 494 of file DbEvalGraph.h.

Member Function Documentation

◆ from()

OdDbEvalNodeId OdDbEvalEdgeInfo::from ( ) const

Returns the Object ID of the originating node of this edge.

◆ isInvertible()

bool OdDbEvalEdgeInfo::isInvertible ( ) const

Returns true if and only if this edge is invertible.

Remarks
An invertible edge can have its originating and terminating nodes swapped based on which of the nodes is activated.

◆ isSuppressed()

bool OdDbEvalEdgeInfo::isSuppressed ( ) const

Returns true if and only if this edge is suppressed.

Remarks
As suppressed edge is temporarily removed from the graph during activation or evaluation. This applies only to invertible pairs of edges.

◆ operator==()

bool OdDbEvalEdgeInfo::operator== ( const OdDbEvalEdgeInfo other) const

◆ refCount()

unsigned long OdDbEvalEdgeInfo::refCount ( ) const

Returns the number of times this edge was added to the graph.

◆ to()

OdDbEvalNodeId OdDbEvalEdgeInfo::to ( ) const

Returns the Object ID of the terminating node of this edge.


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