Representation class for an Ordered Map. More...
#include <OrderedMap.h>
Public Types | |
| enum | { OrderedMapRepVersion } |
 Public Types inherited from casacore::MapRep< key, value > | |
| enum | { MapRepVersion } |
Public Member Functions | |
| OrderedMapRep (const value &, uInt size) | |
| Creates a map with the specified default value, "value", and the internal block size. More... | |
| OrderedMapRep (const value &) | |
| Creates a map with the specified default value, "value". More... | |
| value * | isDefined (const key &) |
| These functions check to see if a mapping is defined between the specified key and some value. More... | |
| const value * | isDefined (const key &) const |
| Returns a non-zero value if a mapping is defined for the key parameter. More... | |
| uInt | ndefined () const |
| Returns the number of user defined mappings. More... | |
| value & | define (const key &, const value &) |
| Defines a mapping (ie. More... | |
| void | remove (const key &) |
| Undefines a mapping (ie. More... | |
| void | clear () |
| Clear the entire map (ie. More... | |
| MapIterRep< key, value > * | getRep (Map< key, value > *) const |
| MapRep< key, value > * | Clone () const |
| uInt | nused () const |
| Get the number of mappings. More... | |
| uInt | ntot () const |
| uInt | incr () const |
| Get or set the Block allocation increment. More... | |
| uInt | incr (uInt nri) |
| ~OrderedMapRep () | |
| Removes a map. More... | |
| Public Member Functions inherited from casacore::NoticeSource | |
| NoticeSource () | |
| virtual | ~NoticeSource () |
| void | notify (const Notice ¬e) |
Sends the note to all NoticeTargets in the target list. More... | |
| Public Member Functions inherited from casacore::MapRep< key, value > | |
| MapRep (const value &dflt) | |
| This is the only MapRep constructor. More... | |
| value & | operator() (const key &ky) |
| This is the mapping function which maps keys to values. More... | |
| const value & | operator() (const key &ky) const |
| value & | defaultVal () |
| Returns the default value for the Map. More... | |
| const value & | defaultVal () const |
| virtual | ~MapRep () |
| Does nothing. More... | |
Protected Member Functions | |
| Int | findKey (const key &, Bool &) const |
| Binary search for the key. More... | |
Protected Attributes | |
| PtrBlock< OrderedPair< key, value > * > | kvblk |
| The blocks to hold the keys and values and the total, used and increment size of these blocks. More... | |
| uInt | nrtot |
| uInt | nrused |
| uInt | nrincr |
| uInt | lastRef |
| The index of the last key used. More... | |
| Protected Attributes inherited from casacore::MapRep< key, value > | |
| value | DefaultVal |
| This is the default value which is return when no match is found. More... | |
Friends | |
| class | OrderedMap< key, value > |
Detailed Description
template<class key, class value>
class casacore::OrderedMapRep< key, value >
Representation class for an Ordered Map.
Review Status
- Reviewed By:
- UNKNOWN
- Date Reviewed:
- before2004/08/25
Definition at line 102 of file OrderedMap.h.
Member Enumeration Documentation
◆ anonymous enum
| anonymous enum |
| Enumerator | |
|---|---|
| OrderedMapRepVersion | |
Definition at line 169 of file OrderedMap.h.
Constructor & Destructor Documentation
◆ OrderedMapRep() [1/2]
| casacore::OrderedMapRep< key, value >::OrderedMapRep | ( | const value & | , |
| uInt | size | ||
| ) |
Creates a map with the specified default value, "value", and the internal block size.
◆ OrderedMapRep() [2/2]
| casacore::OrderedMapRep< key, value >::OrderedMapRep | ( | const value & | ) |
Creates a map with the specified default value, "value".
◆ ~OrderedMapRep()
| casacore::OrderedMapRep< key, value >::~OrderedMapRep | ( | ) |
Removes a map.
Member Function Documentation
◆ clear()
|
virtual |
◆ Clone()
|
virtual |
Implements casacore::MapRep< key, value >.
◆ define()
|
virtual |
◆ findKey()
|
protected |
Binary search for the key.
◆ getRep()
|
virtual |
Implements casacore::MapRep< key, value >.
◆ incr() [1/2]
|
inline |
Get or set the Block allocation increment.
Definition at line 160 of file OrderedMap.h.
References casacore::OrderedMapRep< key, value >::nrincr.
◆ incr() [2/2]
|
inline |
Definition at line 161 of file OrderedMap.h.
References casacore::OrderedMapRep< key, value >::nrincr.
◆ isDefined() [1/2]
|
virtual |
These functions check to see if a mapping is defined between the specified key and some value.
If one is, a pointer to the value is returned, otherwise 0 is returned.
Implements casacore::MapRep< key, value >.
◆ isDefined() [2/2]
|
virtual |
Returns a non-zero value if a mapping is defined for the key parameter.
Implements casacore::MapRep< key, value >.
◆ ndefined()
|
virtual |
Returns the number of user defined mappings.
Implements casacore::MapRep< key, value >.
◆ ntot()
|
inline |
Definition at line 154 of file OrderedMap.h.
References casacore::OrderedMapRep< key, value >::nrtot.
◆ nused()
|
inline |
Get the number of mappings.
Definition at line 153 of file OrderedMap.h.
References casacore::OrderedMapRep< key, value >::nrused.
◆ remove()
|
virtual |
Friends And Related Function Documentation
◆ OrderedMap< key, value >
|
friend |
Definition at line 88 of file OrderedMap.h.
Member Data Documentation
◆ kvblk
|
protected |
The blocks to hold the keys and values and the total, used and increment size of these blocks.
Definition at line 174 of file OrderedMap.h.
◆ lastRef
|
protected |
The index of the last key used.
Definition at line 180 of file OrderedMap.h.
◆ nrincr
|
protected |
Definition at line 177 of file OrderedMap.h.
Referenced by casacore::OrderedMapRep< key, value >::incr().
◆ nrtot
|
protected |
Definition at line 175 of file OrderedMap.h.
Referenced by casacore::OrderedMapRep< key, value >::ntot().
◆ nrused
|
protected |
Definition at line 176 of file OrderedMap.h.
Referenced by casacore::OrderedMapRep< key, value >::nused().
The documentation for this class was generated from the following file:
- casa/Containers/OrderedMap.h
