Retrieval relocation table is modeled as a child class of TColStd_DataMapOfIntegerTransient that stores a handle to the file header section. With that attribute drivers have access to the file header section. More...

#include <BinObjMgt_RRelocationTable.hxx>

Inheritance diagram for BinObjMgt_RRelocationTable:

[legend]

Public Member Functions
const Handle< Storage_HeaderData > &	GetHeaderData () const
	Returns a handle to the header data of the file that is begin read.

void	SetHeaderData (const Handle< Storage_HeaderData > &theHeaderData)
	Sets the storage header data.

void	Clear (const Standard_Boolean doReleaseMemory=Standard_True)

Public Member Functions inherited from NCollection_DataMap< Standard_Integer, Handle< Standard_Transient > >
iterator	begin () const
	Returns an iterator pointing to the first element in the map.

iterator	end () const
	Returns an iterator referring to the past-the-end element in the map.

const_iterator	cbegin () const
	Returns a const iterator pointing to the first element in the map.

const_iterator	cend () const
	Returns a const iterator referring to the past-the-end element in the map.

	NCollection_DataMap ()
	Empty Constructor.

	NCollection_DataMap (const Standard_Integer theNbBuckets, const Handle< NCollection_BaseAllocator > &theAllocator=0L)
	Constructor.

	NCollection_DataMap (const NCollection_DataMap &theOther)
	Copy constructor.

	NCollection_DataMap (NCollection_DataMap &&theOther) noexcept
	Move constructor.

void	Exchange (NCollection_DataMap &theOther)
	Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

NCollection_DataMap &	Assign (const NCollection_DataMap &theOther)
	Assignment. This method does not change the internal allocator.

NCollection_DataMap &	operator= (const NCollection_DataMap &theOther)
	Assignment operator.

NCollection_DataMap &	operator= (NCollection_DataMap &&theOther) noexcept
	Move operator.

void	ReSize (const Standard_Integer N)
	ReSize.

Standard_Boolean	Bind (const Standard_Integer &theKey, const Handle< Standard_Transient > &theItem)
	Bind binds Item to Key in map.

Standard_Boolean	Bind (Standard_Integer &&theKey, const Handle< Standard_Transient > &theItem)
	Bind binds Item to Key in map.

Standard_Boolean	Bind (const Standard_Integer &theKey, Handle< Standard_Transient > &&theItem)
	Bind binds Item to Key in map.

Standard_Boolean	Bind (Standard_Integer &&theKey, Handle< Standard_Transient > &&theItem)
	Bind binds Item to Key in map.

Handle< Standard_Transient > *	Bound (const Standard_Integer &theKey, const Handle< Standard_Transient > &theItem)
	Bound binds Item to Key in map.

Handle< Standard_Transient > *	Bound (Standard_Integer &&theKey, const Handle< Standard_Transient > &theItem)
	Bound binds Item to Key in map.

Handle< Standard_Transient > *	Bound (const Standard_Integer &theKey, Handle< Standard_Transient > &&theItem)
	Bound binds Item to Key in map.

Handle< Standard_Transient > *	Bound (Standard_Integer &&theKey, Handle< Standard_Transient > &&theItem)
	Bound binds Item to Key in map.

Standard_Boolean	IsBound (const Standard_Integer &theKey) const
	IsBound.

Standard_Boolean	UnBind (const Standard_Integer &theKey)
	UnBind removes Item Key pair from map.

const Handle< Standard_Transient > *	Seek (const Standard_Integer &theKey) const
	Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

const Handle< Standard_Transient > &	Find (const Standard_Integer &theKey) const
	Find returns the Item for Key. Raises if Key was not bound.

Standard_Boolean	Find (const Standard_Integer &theKey, Handle< Standard_Transient > &theValue) const
	Find Item for key with copying.

const Handle< Standard_Transient > &	operator() (const Standard_Integer &theKey) const
	operator ()

Handle< Standard_Transient > *	ChangeSeek (const Standard_Integer &theKey)
	ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

Handle< Standard_Transient > &	ChangeFind (const Standard_Integer &theKey)
	ChangeFind returns mofifiable Item by Key. Raises if Key was not bound.

Handle< Standard_Transient > &	operator() (const Standard_Integer &theKey)
	operator ()

void	Clear (const Standard_Boolean doReleaseMemory=Standard_False)
	Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

void	Clear (const Handle< NCollection_BaseAllocator > &theAllocator)
	Clear data and reset allocator.

virtual	~NCollection_DataMap (void)
	Destructor.

Standard_Integer	Size (void) const
	Size.

iterator	begin () const
	Returns an iterator pointing to the first element in the map.

iterator	end () const
	Returns an iterator referring to the past-the-end element in the map.

const_iterator	cbegin () const
	Returns a const iterator pointing to the first element in the map.

const_iterator	cend () const
	Returns a const iterator referring to the past-the-end element in the map.

	NCollection_DataMap ()
	Empty Constructor.

	NCollection_DataMap (const Standard_Integer theNbBuckets, const Handle< NCollection_BaseAllocator > &theAllocator=0L)
	Constructor.

	NCollection_DataMap (const NCollection_DataMap &theOther)
	Copy constructor.

	NCollection_DataMap (NCollection_DataMap &&theOther) noexcept
	Move constructor.

void	Exchange (NCollection_DataMap &theOther)
	Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!

NCollection_DataMap &	Assign (const NCollection_DataMap &theOther)
	Assignment. This method does not change the internal allocator.

NCollection_DataMap &	operator= (const NCollection_DataMap &theOther)
	Assignment operator.

NCollection_DataMap &	operator= (NCollection_DataMap &&theOther) noexcept
	Move operator.

void	ReSize (const Standard_Integer N)
	ReSize.

Standard_Boolean	Bind (const Standard_Integer &theKey, const Handle< Standard_Transient > &theItem)
	Bind binds Item to Key in map.

Standard_Boolean	Bind (Standard_Integer &&theKey, const Handle< Standard_Transient > &theItem)
	Bind binds Item to Key in map.

Standard_Boolean	Bind (const Standard_Integer &theKey, Handle< Standard_Transient > &&theItem)
	Bind binds Item to Key in map.

Standard_Boolean	Bind (Standard_Integer &&theKey, Handle< Standard_Transient > &&theItem)
	Bind binds Item to Key in map.

Handle< Standard_Transient > *	Bound (const Standard_Integer &theKey, const Handle< Standard_Transient > &theItem)
	Bound binds Item to Key in map.

Handle< Standard_Transient > *	Bound (Standard_Integer &&theKey, const Handle< Standard_Transient > &theItem)
	Bound binds Item to Key in map.

Handle< Standard_Transient > *	Bound (const Standard_Integer &theKey, Handle< Standard_Transient > &&theItem)
	Bound binds Item to Key in map.

Handle< Standard_Transient > *	Bound (Standard_Integer &&theKey, Handle< Standard_Transient > &&theItem)
	Bound binds Item to Key in map.

Standard_Boolean	IsBound (const Standard_Integer &theKey) const
	IsBound.

Standard_Boolean	UnBind (const Standard_Integer &theKey)
	UnBind removes Item Key pair from map.

const Handle< Standard_Transient > *	Seek (const Standard_Integer &theKey) const
	Seek returns pointer to Item by Key. Returns NULL is Key was not bound.

const Handle< Standard_Transient > &	Find (const Standard_Integer &theKey) const
	Find returns the Item for Key. Raises if Key was not bound.

Standard_Boolean	Find (const Standard_Integer &theKey, Handle< Standard_Transient > &theValue) const
	Find Item for key with copying.

const Handle< Standard_Transient > &	operator() (const Standard_Integer &theKey) const
	operator ()

Handle< Standard_Transient > &	operator() (const Standard_Integer &theKey)
	operator ()

Handle< Standard_Transient > *	ChangeSeek (const Standard_Integer &theKey)
	ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.

Handle< Standard_Transient > &	ChangeFind (const Standard_Integer &theKey)
	ChangeFind returns mofifiable Item by Key. Raises if Key was not bound.

void	Clear (const Standard_Boolean doReleaseMemory=Standard_False)
	Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.

void	Clear (const Handle< NCollection_BaseAllocator > &theAllocator)
	Clear data and reset allocator.

virtual	~NCollection_DataMap (void)
	Destructor.

Standard_Integer	Size (void) const
	Size.

Public Member Functions inherited from NCollection_BaseMap
Standard_Integer	NbBuckets () const
	NbBuckets.

Standard_Integer	Extent () const
	Extent.

Standard_Boolean	IsEmpty () const
	IsEmpty.

void	Statistics (Standard_OStream &S) const
	Statistics.

const Handle< NCollection_BaseAllocator > &	Allocator () const
	Returns attached allocator.

Additional Inherited Members
Public Types inherited from NCollection_DataMap< Standard_Integer, Handle< Standard_Transient > >
typedef Standard_Integer	key_type
	STL-compliant typedef for key type.

typedef Handle< Standard_Transient >	value_type
	STL-compliant typedef for value type.

typedef NCollection_StlIterator< std::forward_iterator_tag, Iterator, Handle< Standard_Transient >, false >	iterator
	Shorthand for a regular iterator type.

typedef NCollection_StlIterator< std::forward_iterator_tag, Iterator, Handle< Standard_Transient >, true >	const_iterator
	Shorthand for a constant iterator type.

typedef Standard_Integer	key_type
	STL-compliant typedef for key type.

typedef Handle< Standard_Transient >	value_type
	STL-compliant typedef for value type.

typedef NCollection_StlIterator< std::forward_iterator_tag, Iterator, Handle< Standard_Transient >, false >	iterator
	Shorthand for a regular iterator type.

typedef NCollection_StlIterator< std::forward_iterator_tag, Iterator, Handle< Standard_Transient >, true >	const_iterator
	Shorthand for a constant iterator type.

Protected Member Functions inherited from NCollection_DataMap< Standard_Integer, Handle< Standard_Transient > >
Standard_Boolean	lookup (const Standard_Integer &theKey, DataMapNode *&theNode) const
	Lookup for particular key in map.

Standard_Boolean	lookup (const Standard_Integer &theKey, DataMapNode *&theNode, size_t &theHash) const
	Lookup for particular key in map.

bool	IsEqual (const Standard_Integer &theKey1, const Standard_Integer &theKey2) const

size_t	HashCode (const Standard_Integer &theKey, const int theUpperBound) const

Standard_Boolean	lookup (const Standard_Integer &theKey, DataMapNode *&theNode) const
	Lookup for particular key in map.

Standard_Boolean	lookup (const Standard_Integer &theKey, DataMapNode *&theNode, size_t &theHash) const
	Lookup for particular key in map.

bool	IsEqual (const Standard_Integer &theKey1, const Standard_Integer &theKey2) const

size_t	HashCode (const Standard_Integer &theKey, const int theUpperBound) const

Protected Member Functions inherited from NCollection_BaseMap
	NCollection_BaseMap (const Standard_Integer NbBuckets, const Standard_Boolean single, const Handle< NCollection_BaseAllocator > &theAllocator)
	Constructor.

	NCollection_BaseMap (NCollection_BaseMap &&theOther) noexcept
	Move Constructor.

virtual	~NCollection_BaseMap ()
	Destructor.

Standard_Boolean	BeginResize (const Standard_Integer NbBuckets, Standard_Integer &NewBuckets, NCollection_ListNode &data1, NCollection_ListNode &data2) const
	BeginResize.

void	EndResize (const Standard_Integer NbBuckets, const Standard_Integer NewBuckets, NCollection_ListNode data1, NCollection_ListNode data2)
	EndResize.

Standard_Boolean	Resizable () const
	Resizable.

Standard_Integer	Increment ()
	Increment.

Standard_Integer	Decrement ()
	Decrement.

void	Destroy (NCollection_DelMapNode fDel, Standard_Boolean doReleaseMemory=Standard_True)
	Destroy.

Standard_Integer	NextPrimeForMap (const Standard_Integer N) const
	NextPrimeForMap.

void	exchangeMapsData (NCollection_BaseMap &theOther)
	Exchange content of two maps without data copying.

NCollection_BaseMap &	operator= (NCollection_BaseMap &&) noexcept=delete
	Move operator.

	NCollection_BaseMap (const NCollection_BaseMap &)=delete
	Copy Constructor.

NCollection_BaseMap &	operator= (const NCollection_BaseMap &)=delete
	Assign operator.

Protected Attributes inherited from NCollection_BaseMap
Handle< NCollection_BaseAllocator >	myAllocator

NCollection_ListNode **	myData1

NCollection_ListNode **	myData2

Detailed Description

Retrieval relocation table is modeled as a child class of TColStd_DataMapOfIntegerTransient that stores a handle to the file header section. With that attribute drivers have access to the file header section.

Member Function Documentation

◆ Clear()

void BinObjMgt_RRelocationTable::Clear ( const Standard_Boolean doReleaseMemory = Standard_True )

◆ GetHeaderData()

const Handle< Storage_HeaderData > & BinObjMgt_RRelocationTable::GetHeaderData ( ) const

Returns a handle to the header data of the file that is begin read.

◆ SetHeaderData()

void BinObjMgt_RRelocationTable::SetHeaderData ( const Handle< Storage_HeaderData > & theHeaderData )

Sets the storage header data.

Parameters

theHeaderData header data of the file that is begin read

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

BinObjMgt_RRelocationTable.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Clear()

◆ GetHeaderData()

◆ SetHeaderData()