DynamicRegionRRT::SamplingRegion Struct Reference

Representation of a sampling region. More...

#include <DynamicRegionRRT.h>

Public Member Functions
	SamplingRegion (const SkeletonEdgeIterator &_eit)
void	TrackSuccess (const size_t _success, const size_t _attempts)
	Track the success rate of extending into this region. More...
double	GetWeight () const noexcept
	Compute the weight for this region (i.e. success rate). More...
const Vector3d &	GetCenter () const noexcept
	Get the center of this region. More...
bool	LastPoint () const noexcept
	Check if this region is at the last point on its skeleton edge. More...
void	Advance () noexcept
	Advance this region to the next skeleton edge point. More...
SamplingRegion &	operator= (const SamplingRegion &_region)
	Assignment operator. More...
bool	operator== (const SamplingRegion &_region) const
	Equality operator. More...

Data Fields
Internal State
SkeletonEdgeIterator	edgeIterator
	Iterator to region's edge. More...
size_t	edgeIndex {0}
	Which edge point are we at? More...
double	attempts {1}
	Number of attempts to extend into this region. More...
double	successes {1}
	Number of successful attempts. More...

Detailed Description

Representation of a sampling region.

Constructor & Destructor Documentation

SamplingRegion()

DynamicRegionRRT::SamplingRegion::SamplingRegion ( const SkeletonEdgeIterator &  _eit )

inline

Member Function Documentation

Advance()

void DynamicRegionRRT::SamplingRegion::Advance ( )

inlinenoexcept

Advance this region to the next skeleton edge point.

GetCenter()

const Vector3d& DynamicRegionRRT::SamplingRegion::GetCenter ( ) const

inlinenoexcept

Get the center of this region.

GetWeight()

double DynamicRegionRRT::SamplingRegion::GetWeight ( ) const

inlinenoexcept

Compute the weight for this region (i.e. success rate).

LastPoint()

bool DynamicRegionRRT::SamplingRegion::LastPoint ( ) const

inlinenoexcept

Check if this region is at the last point on its skeleton edge.

operator=()

SamplingRegion& DynamicRegionRRT::SamplingRegion::operator= ( const SamplingRegion &  _region )

inline

Assignment operator.

operator==()

bool DynamicRegionRRT::SamplingRegion::operator== ( const SamplingRegion &  _region ) const

inline

Equality operator.

TrackSuccess()

void DynamicRegionRRT::SamplingRegion::TrackSuccess ( const size_t  _success, const size_t  _attempts  )

inline

Track the success rate of extending into this region.

Field Documentation

attempts

double DynamicRegionRRT::SamplingRegion::attempts {1}

Number of attempts to extend into this region.

edgeIndex

size_t DynamicRegionRRT::SamplingRegion::edgeIndex {0}

Which edge point are we at?

edgeIterator

SkeletonEdgeIterator DynamicRegionRRT::SamplingRegion::edgeIterator

Iterator to region's edge.

successes

double DynamicRegionRRT::SamplingRegion::successes {1}

Number of successful attempts.

---

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

• /opt/actions-runner/_work/open-ppl/open-ppl/src/MPLibrary/MPStrategies/DynamicRegionRRT.h