Web Analytics Made Easy - Statcounter
Skip to content

Class SBDDataGraphNodeSelector#

ClassList > SBDDataGraphNodeSelector

This class describes a selector. More...

  • #include <SBDDataGraphNodeSelector.hpp>

Public Functions#

Type Name
SBDDataGraphNodeSelector ()
Constructs a selector.
SBDDataGraphNodeSelector (const SBValueMap & parameterMap)
Constructs a selector.
virtual std::string getNSLExpression () const
Returns an NSL expression equivalent to the selector, if such expression exists, else returns an empty string.
virtual std::string getName () const
Returns the selector's name.
virtual void getNodes (SBNodeIndexer & resultNodeIndexer, const SBNodeIndexer & nodeIndexer)
Selects nodes from nodeIndexer and populatesresultNodeIndexer with the result.
virtual bool isSerializable () const
Returns true when the class is serializable.
virtual void serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) const
Serializes the selector.
virtual void unserialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0))
Unserializes the selector.
virtual ~SBDDataGraphNodeSelector ()
Destructs the selector.

Protected Attributes#

Type Name
SBDDataGraphNodeSelectorData * dataPointer
A pointer to the private data.

Protected Functions#

Type Name
SBDDataGraphNodeSelector (SBDDataGraphNodeSelectorData * dataPointer)
Protected constructor.

Detailed Description#

This class describes a selector in SAMSON.

Please refer to Selectors for more information.

Short name: SBNodeSelector

See also: Selectors

Public Functions Documentation#

function SBDDataGraphNodeSelector [2/3]#

Constructs a selector. 

SBDDataGraphNodeSelector::SBDDataGraphNodeSelector ()

Creates a new SBDDataGraphNodeSelector instance.

function SBDDataGraphNodeSelector [3/3]#

Constructs a selector. 

SBDDataGraphNodeSelector::SBDDataGraphNodeSelector (
    const SBValueMap & parameterMap
)

Constructs a selector from a parameter map.

Initializes the selector using the given parameter map.

Parameters:

  • parameterMap The map of parameters used to configure the selector.

function getNSLExpression#

Returns an NSL expression equivalent to the selector, if such expression exists, else returns an empty string. 

virtual std::string SBDDataGraphNodeSelector::getNSLExpression () const

Returns the NSL expression for the selector.

Provides a Node Specification Language (NSL) expression that represents the selector, if available; otherwise returns an empty string.

Returns:

The NSL expression string, or an empty string if no expression exists.

function getName#

Returns the selector's name. 

virtual std::string SBDDataGraphNodeSelector::getName () const

Returns the name of the selector.

Provides a textual name identifying the selector.

Returns:

The selector's name.

function getNodes#

Selects nodes from nodeIndexer and populatesresultNodeIndexer with the result. 

virtual void SBDDataGraphNodeSelector::getNodes (
    SBNodeIndexer & resultNodeIndexer,
    const SBNodeIndexer & nodeIndexer
)

Retrieves nodes selected by the selector.

Populates the result node indexer with nodes selected from the input node indexer according to the selector's criteria.

Parameters:

  • resultNodeIndexer The indexer that will receive the selected nodes.
  • nodeIndexer The indexer containing the nodes to be filtered.

function isSerializable#

Returns true when the class is serializable. 

virtual bool SBDDataGraphNodeSelector::isSerializable () const

Checks whether the selector is serializable.

Returns true if the selector can be serialized, false otherwise.

Returns:

true if the selector is serializable; otherwise false.

function serialize#

Serializes the selector. 

virtual void SBDDataGraphNodeSelector::serialize (
    SBCSerializer * serializer,
    const SBNodeIndexer & nodeIndexer,
    const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
    const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) const

Writes the selector's state to the given serializer using the specified node indexer and version numbers.

Parameters:

  • serializer The serializer to which the selector is written.
  • nodeIndexer The node indexer associated with the nodes to be serialized.
  • sdkVersionNumber The SDK version number for compatibility.
  • classVersionNumber The class version number for compatibility.

function unserialize#

Unserializes the selector. 

virtual void SBDDataGraphNodeSelector::unserialize (
    SBCSerializer * serializer,
    const SBNodeIndexer & nodeIndexer,
    const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
    const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
)

Reads the selector's state from the given serializer using the specified node indexer and version numbers.

Parameters:

  • serializer The serializer from which the selector is read.
  • nodeIndexer The node indexer associated with the nodes to be unserialized.
  • sdkVersionNumber The SDK version number for compatibility.
  • classVersionNumber The class version number for compatibility.

function ~SBDDataGraphNodeSelector#

Destructs the selector. 

virtual SBDDataGraphNodeSelector::~SBDDataGraphNodeSelector ()

Destroys the selector.

Releases resources associated with the selector.

Protected Attributes Documentation#

variable dataPointer#

A pointer to the private data. 

SBDDataGraphNodeSelectorData* SBDDataGraphNodeSelector::dataPointer;

Protected Functions Documentation#

function SBDDataGraphNodeSelector [1/3]#

Protected constructor. 

SBDDataGraphNodeSelector::SBDDataGraphNodeSelector (
    SBDDataGraphNodeSelectorData * dataPointer
)

Constructs a selector with the given implementation data pointer.

Initializes the selector using the provided data pointer.

Parameters:

  • dataPointer Pointer to the selector's implementation data.