Class SBDDataGraphNode::DescendsFrom

ClassList > SBDDataGraphNode > DescendsFrom

This node predicate returns true if the node descends from a given node or node indexerMore...

Inherits the following classes: SBDDataGraphNodePredicate

Public Functions

Type	Name
	DescendsFrom (SBDDataGraphNode * node) Builds a predicate that will call the corresponding SBDDataGraphNode::descendsFrom function.
	DescendsFrom (const SBNodeIndexer & nodeIndexer) Builds a predicate that will call the corresponding SBDDataGraphNode::descendsFrom function.
	DescendsFrom (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) Builds a predicate that will call the corresponding SBDDataGraphNode::descendsFrom function.
virtual DescendsFrom *	clone () override const Clones the predicate.
virtual bool	operator() (SBDDataGraphNode const * node) override Performs the predicate's operation and returns the result.
virtual bool	operator() (SBDDataGraphNode const * node) override const Performs the predicate's operation and returns the result.
	~DescendsFrom () Destructor.

Detailed Description

This node predicate returns true if the node descends from a given node or node indexer.

See also: Node predicates

Public Functions Documentation

function DescendsFrom [1/3]

Builds a predicate that will call the corresponding SBDDataGraphNode::descendsFrom function.

SBDDataGraphNode::DescendsFrom::DescendsFrom (
    SBDDataGraphNode * node
) 

Constructs a DescendsFrom predicate that checks if a node descends from the given node.

Parameters:

• node The node to compare against.

---

function DescendsFrom [2/3]

Builds a predicate that will call the corresponding SBDDataGraphNode::descendsFrom function.

SBDDataGraphNode::DescendsFrom::DescendsFrom (
    const SBNodeIndexer & nodeIndexer
) 

Constructs a DescendsFrom predicate that checks if a node descends from any node in the given indexer.

Parameters:

• nodeIndexer The indexer containing nodes to compare against.

---

function DescendsFrom [3/3]

Builds a predicate that will call the corresponding SBDDataGraphNode::descendsFrom function.

SBDDataGraphNode::DescendsFrom::DescendsFrom (
    SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer
) 

Constructs a DescendsFrom predicate that checks if a node descends from any node in the given pointer indexer.

Parameters:

• nodePointerIndexer The pointer indexer containing nodes to compare against.

---

function clone

Clones the predicate.

virtual DescendsFrom * SBDDataGraphNode::DescendsFrom::clone () override const

Creates a copy of this predicate.

Returns:

A new DescendsFrom predicate that is a copy of this predicate.

---

function operator()

Performs the predicate's operation and returns the result.

virtual bool SBDDataGraphNode::DescendsFrom::operator() (
    SBDDataGraphNode const * node
) override

Evaluates the predicate on the given node.

Parameters:

• node The node to test.

Returns:

true if the node descends from the specified node(s), otherwise false.

---

function operator()

Performs the predicate's operation and returns the result.

virtual bool SBDDataGraphNode::DescendsFrom::operator() (
    SBDDataGraphNode const * node
) override const

Evaluates whether a node descends from the reference node or node indexer.

This predicate checks if the provided node descends from the node, node indexer, or pointer indexer stored in this predicate instance.

Parameters:

• node The node to test.

Returns:

true if node descends from the reference; otherwise false.

---

function ~DescendsFrom

Destructor.

SBDDataGraphNode::DescendsFrom::~DescendsFrom () 

---