axom::slam::policies::RuntimeOffset< IntType > Struct Template Reference

A policy class for the offset in a set. The offset can be set at runtime. More...

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

Inheritance diagram for axom::slam::policies::RuntimeOffset< IntType >:

Public Member Functions
	RuntimeOffset (IntType off=DEFAULT_VALUE)
IntType	offset () const
IntType &	offset ()
IntType	operator() () const
IntType &	operator() ()
bool	isValid (bool) const

Static Public Attributes
OrderedSet_Offset_Policies
A few default policies for the offset of an OrderedSet
static const IntType	DEFAULT_VALUE = IntType {}

Detailed Description

template<typename IntType>
struct axom::slam::policies::RuntimeOffset< IntType >

A policy class for the offset in a set. The offset can be set at runtime.

Constructor & Destructor Documentation

RuntimeOffset()

template<typename IntType>

axom::slam::policies::RuntimeOffset< IntType >::RuntimeOffset ( IntType  off = DEFAULT_VALUE )

inline

Member Function Documentation

offset() [1/2]

template<typename IntType>

IntType axom::slam::policies::RuntimeOffset< IntType >::offset ( ) const

inline

Referenced by axom::slam::policies::RuntimeOffset< PosType >::operator()(), axom::slam::policies::CompileTimeOffset< IntType, INT_VAL >::operator()(), and axom::slam::policies::ZeroOffset< SetPosition >::operator()().

offset() [2/2]

template<typename IntType>

IntType& axom::slam::policies::RuntimeOffset< IntType >::offset ( )

inline

operator()() [1/2]

template<typename IntType>

IntType axom::slam::policies::RuntimeOffset< IntType >::operator() ( ) const

inline

operator()() [2/2]

template<typename IntType>

IntType& axom::slam::policies::RuntimeOffset< IntType >::operator() ( )

inline

isValid()

template<typename IntType>

bool axom::slam::policies::RuntimeOffset< IntType >::isValid ( bool  ) const

inline

Member Data Documentation

DEFAULT_VALUE

template<typename IntType>

const IntType axom::slam::policies::RuntimeOffset< IntType >::DEFAULT_VALUE = IntType {}

static

Referenced by axom::slam::policies::ZeroOffset< SetPosition >::offset().

---

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

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