axom::slam::MapBase< SetPositionType > Class Template Reference

A base class specifying methods that support operations of a Map, associating value(s) to each element in a Set. MapBase can be used as a base class pointer to a templated Map object. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/slam/MapBase.hpp>

Inheritance diagram for axom::slam::MapBase< SetPositionType >:

Public Types
using	SetPosition = SetPositionType

Public Member Functions
virtual	~MapBase ()
virtual SetPosition	size () const =0
	Get the number of entities in the set used by this map. More...
virtual bool	isValid (bool verboseOutput) const =0
	Checks whether the Map is valid. More...

Detailed Description

template<typename SetPositionType = slam::DefaultPositionType>
class axom::slam::MapBase< SetPositionType >

A base class specifying methods that support operations of a Map, associating value(s) to each element in a Set. MapBase can be used as a base class pointer to a templated Map object.

See also

Map

Member Typedef Documentation

SetPosition

template<typename SetPositionType = slam::DefaultPositionType>

using axom::slam::MapBase< SetPositionType >::SetPosition = SetPositionType

Constructor & Destructor Documentation

~MapBase()

template<typename SetPositionType = slam::DefaultPositionType>

virtual axom::slam::MapBase< SetPositionType >::~MapBase ( )

inlinevirtual

Member Function Documentation

size()

template<typename SetPositionType = slam::DefaultPositionType>

virtual SetPosition axom::slam::MapBase< SetPositionType >::size ( ) const

pure virtual

Get the number of entities in the set used by this map.

Returns

The number of entities in the set used in the map.

Implemented in axom::slam::BivariateMap< SetType, DataType, StridePolicy >, axom::slam::SubMap< SetType, DataType, SuperMapType, StridePolicy >, axom::slam::Map< SetType, DataType, StridePolicy >, axom::slam::Map< slam::Set<>, GrayLeafVertexRelation >, axom::slam::Map< slam::Set<>, int >, axom::slam::Map< slam::Set<>, GrayLeafElementRelation >, axom::slam::Map< slam::Set<>, GrayLeafSet >, axom::slam::Map< slam::Set<>, BlockIndex >, axom::slam::Map< slam::Set< IndexType, IndexType >, BitsetType >, axom::slam::Map< slam::Set< VertexIndex >, SpacePt >, axom::slam::Map< slam::Set<>, SpaceVector >, and axom::slam::Map< slam::Set< CoordType, CoordType >, OctreeLevelType * >.

Referenced by axom::slam::MapBase< slam::Set<> ::PositionType >::~MapBase().

isValid()

template<typename SetPositionType = slam::DefaultPositionType>

virtual bool axom::slam::MapBase< SetPositionType >::isValid ( bool  verboseOutput ) const

pure virtual

Checks whether the Map is valid.

Returns

True if valid, false otherwise.

Implemented in axom::slam::BivariateMap< SetType, DataType, StridePolicy >, axom::slam::Map< SetType, DataType, StridePolicy >, axom::slam::Map< slam::Set<>, GrayLeafVertexRelation >, axom::slam::Map< slam::Set<>, int >, axom::slam::Map< slam::Set<>, GrayLeafElementRelation >, axom::slam::Map< slam::Set<>, GrayLeafSet >, axom::slam::Map< slam::Set<>, BlockIndex >, axom::slam::Map< slam::Set< IndexType, IndexType >, BitsetType >, axom::slam::Map< slam::Set< VertexIndex >, SpacePt >, axom::slam::Map< slam::Set<>, SpaceVector >, axom::slam::Map< slam::Set< CoordType, CoordType >, OctreeLevelType * >, and axom::slam::SubMap< SetType, DataType, SuperMapType, StridePolicy >.

Referenced by axom::slam::MapBase< slam::Set<> ::PositionType >::~MapBase().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/slam/MapBase.hpp