Open Inventor Reference
Public Member Functions | List of all members
SoAuditorList Class Reference

SoAuditorList class. More...

#include <Inventor/misc/SoAuditorList.h>

Inheritance diagram for SoAuditorList:
SbPList

Public Member Functions

 SoAuditorList ()
 Constructor and destructor.
 
 ~SoAuditorList ()
 
void append (void *auditor, SoNotRec::Type type)
 Adds an auditor of the given type to the list.
 
void set (int index, void *auditor, SoNotRec::Type type)
 Sets auditor and type for given index.
 
int find (void *auditor, SoNotRec::Type type) const
 Finds an auditor in the list, returning the index or -1 if not found.
 
int findLast (void *auditor, SoNotRec::Type type) const
 Finds an auditor in the list, starting from the end, returning the index or -1 if not found.
 
void * getObject (int index) const
 Returns object or type for given index.
 
SoNotRec::Type getType (int index) const
 
void remove (int index)
 Removes an auditor from the list.
 
void remove (void *auditor, SoNotRec::Type type)
 
int getLength () const
 Returns number of auditors in list.
 
void notify (SoNotList *list)
 Propagates notification to all auditors in list.
 

Detailed Description

This class maintains a list of instances that audit (receive notification from) an SoBase or SoField. Each entry in the list consists of a pointer to the auditor (base or field) instance and a type code of type SoNotRec::Type.

The type of the auditor object pointer depends on the type code, as follows: 

Type code:      Auditor object pointer:

CONTAINER       The SoFieldContainer containing the field
PARENT          The parent node
SENSOR          The SoDataSensor instance
FIELD           The destination field instance
ENGINE          The destination field instance

Since there are two entries in the underlying SbPList for each auditor, some of these methods have to do some fancy footwork.

Definition at line 87 of file SoAuditorList.h.

Constructor & Destructor Documentation

◆ SoAuditorList()

SoAuditorList::SoAuditorList ( )

◆ ~SoAuditorList()

SoAuditorList::~SoAuditorList ( )

Member Function Documentation

◆ append()

void SoAuditorList::append ( void *  auditor,
SoNotRec::Type  type 
)

◆ find()

int SoAuditorList::find ( void *  auditor,
SoNotRec::Type  type 
) const

◆ findLast()

int SoAuditorList::findLast ( void *  auditor,
SoNotRec::Type  type 
) const

◆ getLength()

int SoAuditorList::getLength ( ) const

◆ getObject()

void * SoAuditorList::getObject ( int  index) const

◆ getType()

SoNotRec::Type SoAuditorList::getType ( int  index) const

◆ notify()

void SoAuditorList::notify ( SoNotList *  list)

◆ remove() [1/2]

void SoAuditorList::remove ( int  index)

◆ remove() [2/2]

void SoAuditorList::remove ( void *  auditor,
SoNotRec::Type  type 
)
inline

Definition at line 112 of file SoAuditorList.h.

References SbPList::find(), and SbPList::remove().

◆ set()

void SoAuditorList::set ( int  index,
void *  auditor,
SoNotRec::Type  type 
)
The documentation for this class was generated from the following file: