Class SBCReferenceTarget#

ClassList > SBCReferenceTarget

The class SBCReferenceTarget is used to represent objects which may reference and be referenced by other objects.More...

#include <SBCReferenceTarget.hpp>

Inherited by the following classes: SBCGraph, SBCGraphNode, SBCReferenceListLink, SBDApp, SBDAssistant, SBDAssistantAnswer, SBDDataGraphNode, SBDDataGraphNodeColorScheme, SBDDataGraphNodeMaterial, SBDDataGraphNodeMaterialAppearance, SBGRenderNode, SBMStructuralModelGrid, SBMVisualModelGeometryArray, SBMVisualModelSurface, SBMVisualModelTexture, SBSNeighborSearch

Public Functions#

Type	Name
	SBCReferenceTarget () Builds the reference target.
unsigned int	getMemoryFootprint () const Returns the memory footprint.
void	printReferencesToOwners () const Prints the references to the owners of this reference target.
virtual	~SBCReferenceTarget () Destructor.

Protected Attributes#

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

Protected Functions#

Type	Name
	SBCReferenceTarget (SBCReferenceTargetData * dataPointer) Protected constructor.
void	removeAllReferenceOwners () Stops all the reference owners from referencing this reference target.

Detailed Description#

In particular, since the signalling system is based on the referencing system, a class has to derive from SBCReferenceTarget in order for its objects to be able to receive signals.

Public Functions Documentation#

function SBCReferenceTarget [2/2]#

Builds the reference target.

SBCReferenceTarget::SBCReferenceTarget ()

Constructs a new SBCReferenceTarget instance.

This default constructor initializes the reference target and sets up its internal data structures.

function getMemoryFootprint#

Returns the memory footprint.

unsigned int SBCReferenceTarget::getMemoryFootprint () const

Retrieves the memory footprint of this reference target.

Returns the size, in bytes, of the data structures used to store owner references.

Returns:

The memory footprint in bytes.

function printReferencesToOwners#

Prints the references to the owners of this reference target.

void SBCReferenceTarget::printReferencesToOwners () const

Prints information about all owners referencing this target.

The method outputs the target's address and lists each owner reference to standard output.

function ~SBCReferenceTarget#

Destructor.

virtual SBCReferenceTarget::~SBCReferenceTarget ()

Destroys the SBCReferenceTarget instance.

This destructor releases the internal data associated with the reference target.

Protected Attributes Documentation#

variable dataPointer#

A pointer to the private data.

SBCReferenceTargetData* SBCReferenceTarget::dataPointer;

Protected Functions Documentation#

function SBCReferenceTarget [1/2]#

Protected constructor.

SBCReferenceTarget::SBCReferenceTarget (
    SBCReferenceTargetData * dataPointer
)

Constructs a SBCReferenceTarget with an existing data pointer.

This constructor initializes the reference target using the supplied data pointer.

Parameters:

dataPointer Pointer to the target's internal data.

function removeAllReferenceOwners#

Stops all the reference owners from referencing this reference target.

void SBCReferenceTarget::removeAllReferenceOwners ()

Removes all owner references from this target.

This method instructs the internal data to stop referencing this target.