Coin Logo http://www.sim.no
http://www.coin3d.org

SoAuditorList Class Reference

The SoAuditorList class is used to keep track of auditors for certain object classes. More...

#include <Inventor/lists/SoAuditorList.h>

Inheritance diagram for SoAuditorList:
SbPList

Public Member Functions

 SoAuditorList (void)
 
 ~SoAuditorList ()
 
void append (void *const auditor, const SoNotRec::Type type)
 
void set (const int index, void *const auditor, const SoNotRec::Type type)
 
void * getObject (const int index) const
 
SoNotRec::Type getType (const int index) const
 
int getLength (void) const
 
int find (void *const auditor, const SoNotRec::Type type) const
 
void remove (const int index)
 
void remove (void *const auditor, const SoNotRec::Type type)
 
void notify (SoNotList *l)
 

Detailed Description

The SoAuditorList class is used to keep track of auditors for certain object classes.

This class is mainly for internal use (from SoBase) and it should not be necessary to be familiar with it for "ordinary" Coin use.

Constructor & Destructor Documentation

◆ SoAuditorList()

SoAuditorList::SoAuditorList ( void )

Default constructor.

◆ ~SoAuditorList()

SoAuditorList::~SoAuditorList ( )

Destructor.

Member Function Documentation

◆ append()

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

Append an auditor of type to the list.

References SbPList::append().

Referenced by SoField::addAuditor().

◆ set()

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

Set auditor pointer and auditor type in list at index.

References getLength(), and SbPList::set().

◆ getObject()

void * SoAuditorList::getObject ( const int index) const

Returns auditor pointer at index.

References SbPList::operator[]().

Referenced by find(), notify(), and SoField::~SoField().

◆ getType()

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

Returns auditor type at index.

Referenced by find(), notify(), and SoField::~SoField().

◆ getLength()

int SoAuditorList::getLength ( void ) const

Returns number of elements in list.

References SbPList::getLength().

Referenced by find(), SoBase::getAuditors(), notify(), SoField::notify(), remove(), set(), and SoField::~SoField().

◆ find()

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

Find auditor of type in list and return index. Returns -1 if auditor is not in the list.

References getLength(), getObject(), and getType().

Referenced by remove().

◆ remove() [1/2]

void SoAuditorList::remove ( const int index)

Remove auditor at index.

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

Referenced by SoBase::getAuditors(), remove(), and SoField::removeAuditor().

◆ remove() [2/2]

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

Remove auditor of type from list.

References find(), and remove().

◆ notify()

void SoAuditorList::notify ( SoNotList * l)

Send notification to all our auditors.

References SbPList::append(), SbPList::find(), getLength(), getObject(), and getType().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Thu Jan 16 2025 for Coin by Doxygen. 1.12.0