Class SBDDataGraphNode::IsIn#

ClassList > SBDDataGraphNode > IsIn

This node predicate returns true if the node descends from a given node or node indexer, or if the node belongs to a group stored in the given node or node indexerMore...

Inherits the following classes: SBDDataGraphNodePredicate

Public Functions#

Type	Name
	IsIn (SBDDataGraphNode * node) Builds a predicate that will call the corresponding SBDDataGraphNode::isIn function.
	IsIn (const SBNodeIndexer & nodeIndexer) Builds a predicate that will call the corresponding SBDDataGraphNode::isIn function.
	IsIn (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) Builds a predicate that will call the corresponding SBDDataGraphNode::isIn function.
virtual IsIn *	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.
	~IsIn () Destructor.

Detailed Description#

This node predicate returns true if the node descends from a given node or node indexer, or if the node belongs to a group stored in the given node or node indexer.

See also: Node predicates

Public Functions Documentation#

function IsIn [1/3]#

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

SBDDataGraphNode::IsIn::IsIn (
    SBDDataGraphNode * node
)

Constructs an IsIn predicate using a single node.

The predicate will evaluate to true for nodes that are in the hierarchy of the specified node or belong to a group stored in node.

Parameters:

node The node used as the reference for the predicate.

function IsIn [2/3]#

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

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

Constructs an IsIn predicate using a node indexer.

The predicate will evaluate to true for nodes that are descendants of any node in the given nodeIndexer or belong to a group stored in those nodes.

Parameters:

nodeIndexer An indexer containing nodes used as references for the predicate.

function IsIn [3/3]#

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

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

Constructs an IsIn predicate using a pointer indexer.

The predicate will evaluate to true for nodes that are in the hierarchy of any node referenced by the nodePointerIndexer or belong to a group stored in those nodes.

Parameters:

nodePointerIndexer A pointer indexer containing node pointers used as references for the predicate.

function clone#

Clones the predicate.

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

Creates a clone of this predicate.

The cloned predicate will have the same reference node(s) as this instance.

Returns:

A pointer to a new IsIn predicate that is a copy of this instance.

function operator()#

Performs the predicate's operation and returns the result.

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

Evaluates whether a node satisfies the IsIn predicate.

The predicate returns true if the given node descends from the reference node(s) or belongs to a group stored in them.

Parameters:

node The node to evaluate.

Returns:

true if node satisfies the predicate; otherwise false.

function operator()#

Performs the predicate's operation and returns the result.

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

Evaluates whether a node satisfies the IsIn predicate (const overload).

The predicate returns true if the given node descends from the reference node(s) or belongs to a group stored in them.

Parameters:

node The node to evaluate.

Returns:

true if node satisfies the predicate; otherwise false.

function ~IsIn#

Destructor.

SBDDataGraphNode::IsIn::~IsIn ()

Destroys the IsIn predicate.