Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
lists/SoAuditorList.h
1 #ifndef COIN_SOAUDITORLIST_H
2 #define COIN_SOAUDITORLIST_H
3 
4 /**************************************************************************\
5  * Copyright (c) Kongsberg Oil & Gas Technologies AS
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are
10  * met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in the
17  * documentation and/or other materials provided with the distribution.
18  *
19  * Neither the name of the copyright holder nor the names of its
20  * contributors may be used to endorse or promote products derived from
21  * this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 \**************************************************************************/
35 
36 #include <Inventor/lists/SbPList.h>
37 #include <Inventor/misc/SoNotification.h>
38 
39 
40 // Important note: do not expand this class with any further data
41 // unless absolutely necessary, as every SoBase object contains (by
42 // value) an SoAuditorList.
43 //
44 // So if you increase the size of objects of this class by just a
45 // minor amount, it could have adverse effects on the total memory
46 // usage in a Coin application, as SoBase-derived objects are
47 // ubiquitous within the system.
48 //
49 // -mortene
50 
51 
52 class COIN_DLL_API SoAuditorList : private SbPList {
53  typedef SbPList inherited;
54 
55 public:
56  SoAuditorList(void);
57  ~SoAuditorList();
58 
59  void append(void * const auditor, const SoNotRec::Type type);
60 
61  void set(const int index, void * const auditor, const SoNotRec::Type type);
62  void * getObject(const int index) const;
63  SoNotRec::Type getType(const int index) const;
64 
65  int getLength(void) const;
66  int find(void * const auditor, const SoNotRec::Type type) const;
67 
68  void remove(const int index);
69  void remove(void * const auditor, const SoNotRec::Type type);
70 
71  void notify(SoNotList * l);
72 
73 private:
74  // Hide these, as they are "dangerous" for this class, in the sense
75  // that they need to be rewritten to behave correctly.
76  SoAuditorList(const int) { }
77  SoAuditorList(const SoAuditorList & l) : SbPList(l) { }
78  void * get(const int) const { return NULL; }
79  void set(const int, void * const) { }
80  void copy(const SbPList &) { }
81  void append(const void *) { }
82  int find(const void *) const { return -1; }
83  void insert(const void *, const int) { }
84  void removeFast(const int) { }
85  void truncate(const int, const int = 0) { }
86  void push(const void *) { }
87  void * pop(void) { return NULL; }
88  SbPList & operator=(const SbPList &) { return *this; }
89  operator void ** (void) { return static_cast<void **> (NULL); }
90  operator const void ** (void) const { return static_cast<const void **>(NULL); }
91  void * operator[](const int) const { return NULL; }
92  void * & operator[](const int) { return SbPList::operator[](0); }
93  int operator==(const SbPList &) const { return 0; }
94  int operator!=(const SbPList &) const { return 0; }
95 
96  void doNotify(SoNotList * l, const void * auditor, const SoNotRec::Type type);
97 
98 };
99 
100 #endif // !COIN_SOAUDITORLIST_H
void removeFast(const int index)
Definition: lists/SbPList.h:94
int find(const void *item) const
Definition: SbPList.cpp:222
The SbPList class is a container class for void pointers.
Definition: lists/SbPList.h:40
void append(void *item)
Definition: lists/SbPList.h:87
void copy(const SbPList &l)
Definition: SbPList.cpp:171
SbPList & operator=(const SbPList &l)
Definition: SbPList.cpp:183
The SoAuditorList class is used to keep track of auditors for certain object classes.
Definition: lists/SoAuditorList.h:52
int operator!=(const SbPList &l) const
Definition: lists/SbPList.h:138
int operator==(const SbPList &l) const
Definition: SbPList.cpp:284
void *& operator[](const int index) const
Definition: lists/SbPList.h:128
The SoNotList class is a list of SoNotRec notification records.
Definition: SoNotification.h:43
SbPList(const int sizehint=DEFAULTSIZE)
Definition: SbPList.cpp:144
void truncate(const int length, const int fit=0)
Definition: lists/SbPList.h:109
int getLength(void) const
Definition: lists/SbPList.h:103
void insert(void *item, const int insertbefore)
Definition: SbPList.cpp:236
Type
Definition: SoNotRec.h:44