NavWrapper< NavigableTerminalNode > Class Reference

Specialized wrapper for singular navigable data objects. More...

#include <NavWrapper.h>

Collaboration diagram for NavWrapper< NavigableTerminalNode >:

Public Types
typedef NavigableTerminalNode	navimpl_t
	Publish navigation implementation type.
typedef navimpl_t::container_type	container_type
	{
typedef navimpl_t::constituent_type	constituent_type
typedef navimpl_t::parameter_type	parameter_type
typedef navimpl_t::object_iter	object_iter
typedef navimpl_t::external_index_type	external_index_type

Public Member Functions
	NavWrapper ()
	Default constructor.
virtual	~NavWrapper ()
	Base class destructor.
virtual void	fillToken (INavigationToken &) const
	{
virtual void	fillToken (INavigationToken &, const std::any &) const
void	putElement (const container_type *pCont, const constituent_type *pObj, const parameter_type &oPar=parameter_type(), size_t sizeHint=0)
	Add element to Navigable store.
void	insertElement (const container_type *pCont, const constituent_type *pObj, const parameter_type &oPar=parameter_type(), size_t sizeHint=0)
	Insert element into Navigable store.
void	reweight (const constituent_type *pObj, const parameter_type &oPar=parameter_type())
bool	remove (const constituent_type *pObj)
bool	removeAll ()
bool	contains (const constituent_type *pObj) const
virtual object_iter	begin () const
virtual object_iter	end () const
virtual size_t	size () const
parameter_type	getParameter (const constituent_type *pObj) const
const container_type *	getContainer (const constituent_type *pObj) const
bool	getIndex (const constituent_type *pObj, external_index_type &iObj) const

Protected Member Functions
navimpl_t &	getNavImpl ()

Private Attributes
navimpl_t	m_nav
	Wrapped Navigable implementation.

Detailed Description

Specialized wrapper for singular navigable data objects.

Date

June 2, 2006

Author

Peter Loch loch@.nosp@m.phys.nosp@m.ics.a.nosp@m.rizo.nosp@m.na.ed.nosp@m.u

Specialization of the NavWrapper template for singular data objects, i.e. data objects without constituents. All constituent store manipulations (adding, removing, reweighting, etc.) are omitted.

Definition at line 199 of file NavWrapper.h.

Member Typedef Documentation

constituent_type

typedef navimpl_t::constituent_type NavWrapper< NavigableTerminalNode >::constituent_type

Definition at line 31 of file NavWrapper.h.

container_type

typedef navimpl_t::container_type NavWrapper< NavigableTerminalNode >::container_type

{

Publish important types from Navigable, new style

}

{ Publish important types from Navigable, old style, soon to be obsolete!

Definition at line 30 of file NavWrapper.h.

external_index_type

typedef navimpl_t::external_index_type NavWrapper< NavigableTerminalNode >::external_index_type

Definition at line 34 of file NavWrapper.h.

navimpl_t

typedef NavigableTerminalNode NavWrapper< NavigableTerminalNode >::navimpl_t

Publish navigation implementation type.

Definition at line 19 of file NavWrapper.h.

object_iter

typedef navimpl_t::object_iter NavWrapper< NavigableTerminalNode >::object_iter

Definition at line 33 of file NavWrapper.h.

parameter_type

typedef navimpl_t::parameter_type NavWrapper< NavigableTerminalNode >::parameter_type

Definition at line 32 of file NavWrapper.h.

Constructor & Destructor Documentation

NavWrapper()

NavWrapper< NavigableTerminalNode >::NavWrapper ( )

inline

Default constructor.

Definition at line 204 of file NavWrapper.h.

{ };

~NavWrapper()

virtual NavWrapper< NavigableTerminalNode >::~NavWrapper ( )

inlinevirtual

Base class destructor.

Definition at line 206 of file NavWrapper.h.

{ };

Member Function Documentation

begin()

virtual object_iter NavWrapper< NavigableTerminalNode >::begin ( ) const

inlinevirtual

Definition at line 128 of file NavWrapper.h.

{ return m_nav.begin(); }

contains()

bool NavWrapper< NavigableTerminalNode >::contains ( const constituent_type * pObj ) const

inline

Definition at line 117 of file NavWrapper.h.

  { return m_nav.contains(pObj); }

end()

virtual object_iter NavWrapper< NavigableTerminalNode >::end ( ) const

inlinevirtual

Definition at line 129 of file NavWrapper.h.

{ return m_nav.end(); }

fillToken() [1/2]

virtual void NavWrapper< NavigableTerminalNode >::fillToken ( INavigationToken & ) const

inlinevirtual

{

Do-nothing visitor

Definition at line 209 of file NavWrapper.h.

{ };

fillToken() [2/2]

virtual void NavWrapper< NavigableTerminalNode >::fillToken ( INavigationToken & , const std::any &  ) const

inlinevirtual

Definition at line 210 of file NavWrapper.h.

                                      { };

getContainer()

const container_type * NavWrapper< NavigableTerminalNode >::getContainer ( const constituent_type * pObj ) const

inline

Definition at line 142 of file NavWrapper.h.

  { return m_nav.getContainer(pObj); }

getIndex()

bool NavWrapper< NavigableTerminalNode >::getIndex ( const constituent_type * pObj, external_index_type & iObj ) const

inline

Definition at line 150 of file NavWrapper.h.

  { return m_nav.getIndex(pObj,iObj); }

getNavImpl()

navimpl_t & NavWrapper< NavigableTerminalNode >::getNavImpl ( )

inlineprotected

Definition at line 161 of file NavWrapper.h.

{ return m_nav; }

getParameter()

parameter_type NavWrapper< NavigableTerminalNode >::getParameter ( const constituent_type * pObj ) const

inline

Definition at line 133 of file NavWrapper.h.

  { return m_nav.getParameter(pObj); }

insertElement()

void NavWrapper< NavigableTerminalNode >::insertElement ( const container_type * pCont, const constituent_type * pObj, const parameter_type & oPar = parameter_type(), size_t sizeHint = 0 )

inline

Insert element into Navigable store.

Definition at line 81 of file NavWrapper.h.

  { m_nav.insertElement(pCont,pObj,oPar,sizeHint); }

putElement()

void NavWrapper< NavigableTerminalNode >::putElement ( const container_type * pCont, const constituent_type * pObj, const parameter_type & oPar = parameter_type(), size_t sizeHint = 0 )

inline

Add element to Navigable store.

Element is referenced by pointer (internal linear index search).

Definition at line 69 of file NavWrapper.h.

  { m_nav.putElement(pCont,pObj,oPar,sizeHint); }

remove()

bool NavWrapper< NavigableTerminalNode >::remove ( const constituent_type * pObj )

inline

Definition at line 110 of file NavWrapper.h.

  { return m_nav.remove(pObj); }

removeAll()

bool NavWrapper< NavigableTerminalNode >::removeAll ( )

inline

Definition at line 114 of file NavWrapper.h.

{ return m_nav.removeAll(); }

reweight()

void NavWrapper< NavigableTerminalNode >::reweight ( const constituent_type * pObj, const parameter_type & oPar = parameter_type() )

inline

Definition at line 98 of file NavWrapper.h.

  { m_nav.reweight(pObj,oPar); }

size()

virtual size_t NavWrapper< NavigableTerminalNode >::size ( ) const

inlinevirtual

Definition at line 130 of file NavWrapper.h.

{ return size_t(m_nav.size()); }

Member Data Documentation

m_nav

navimpl_t NavWrapper< NavigableTerminalNode >::m_nav

private

Wrapped Navigable implementation.

Definition at line 166 of file NavWrapper.h.

---

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

• NavWrapper.h