Detailed Description

Range specification type, with several uses.

Definition at line 50 of file CAngularObservationMesh.h.

#include <mrpt/opengl/CAngularObservationMesh.h>

Classes
union	rd
	Union type with the actual data. More...

Public Member Functions
	TDoubleRange (double a, double b, double c)
	Constructor from initial value, final value and range. More...

	TDoubleRange (double a, double b, size_t c)
	Constructor from initial value, final value and amount of samples. More...

	TDoubleRange (double a, size_t b, bool c)
	Constructor from aperture, amount of samples and scan direction. More...

double	aperture () const
	Returns the total aperture of the range. More...

double	initialValue () const
	Returns the first value of the range. More...

double	finalValue () const
	Returns the last value of the range. More...

double	increment () const
	Returns the increment between two consecutive values of the range. More...

size_t	amount () const
	Returns the total amount of values in this range. More...

void	values (std::vector< double > &vals) const
	Gets a vector with every value in the range. More...

bool	negToPos () const
	Returns the direction of the scan. More...

Static Public Member Functions
static TDoubleRange	CreateFromIncrement (double initial, double final, double increment)
	Creates a range of values from the initial value, the final value and the increment. More...

static TDoubleRange	CreateFromAmount (double initial, double final, size_t amount)
	Creates a range of values from the initial value, the final value and a desired amount of samples. More...

static TDoubleRange	CreateFromAperture (double aperture, size_t amount, bool negToPos=true)
	Creates a zero-centered range of values from an aperture, an amount of samples and a direction. More...

Private Attributes
char	rangeType
	Range type. More...

union mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd	rangeData

Constructor & Destructor Documentation

◆ TDoubleRange() [1/3]

mrpt::opengl::CAngularObservationMesh::TDoubleRange::TDoubleRange	(	double	a,
		double	b,
		double	c
	)

inline

Constructor from initial value, final value and range.

Definition at line 93 of file CAngularObservationMesh.h.

References mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::final, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::increment, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::initial, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode0, and rangeData.

Referenced by CreateFromAmount(), CreateFromAperture(), and CreateFromIncrement().

Here is the caller graph for this function:

◆ TDoubleRange() [2/3]

mrpt::opengl::CAngularObservationMesh::TDoubleRange::TDoubleRange	(	double	a,
		double	b,
		size_t	c
	)

inline

Constructor from initial value, final value and amount of samples.

Definition at line 102 of file CAngularObservationMesh.h.

References mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::amount, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::final, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::initial, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode1, and rangeData.

◆ TDoubleRange() [3/3]

mrpt::opengl::CAngularObservationMesh::TDoubleRange::TDoubleRange	(	double	a,
		size_t	b,
		bool	c
	)

inline

Constructor from aperture, amount of samples and scan direction.

Definition at line 111 of file CAngularObservationMesh.h.

References mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::amount, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::aperture, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode2, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::negToPos, and rangeData.

Member Function Documentation

◆ amount()

size_t mrpt::opengl::CAngularObservationMesh::TDoubleRange::amount ( ) const

inline

Returns the total amount of values in this range.

Exceptions

std::logic_error on invalid range type.

Definition at line 245 of file CAngularObservationMesh.h.

References mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::amount, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::final, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::increment, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::initial, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode0, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode1, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode2, rangeData, rangeType, and mrpt::sign().

Referenced by CreateFromAmount(), CreateFromAperture(), and mrpt::opengl::CAngularObservationMesh::trace1DSetOfRays().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aperture()

double mrpt::opengl::CAngularObservationMesh::TDoubleRange::aperture ( ) const

inline

Returns the total aperture of the range.

Exceptions

std::logic_error on invalid range type.

Definition at line 151 of file CAngularObservationMesh.h.

References mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::aperture, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::final, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::increment, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::initial, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode0, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode1, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode2, rangeData, rangeType, and mrpt::sign().

Referenced by CreateFromAperture(), mrpt::opengl::CAngularObservationMesh::FTrace2D< T >::operator()(), and mrpt::opengl::CAngularObservationMesh::trace1DSetOfRays().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateFromAmount()

static TDoubleRange mrpt::opengl::CAngularObservationMesh::TDoubleRange::CreateFromAmount	(	double	initial,
		double	final,
		size_t	amount
	)

inlinestatic

Creates a range of values from the initial value, the final value and a desired amount of samples.

Definition at line 133 of file CAngularObservationMesh.h.

References amount(), and TDoubleRange().

Here is the call graph for this function:

◆ CreateFromAperture()

static TDoubleRange mrpt::opengl::CAngularObservationMesh::TDoubleRange::CreateFromAperture	(	double	aperture,
		size_t	amount,
		bool	negToPos = `true`
	)

inlinestatic

Creates a zero-centered range of values from an aperture, an amount of samples and a direction.

Definition at line 142 of file CAngularObservationMesh.h.

References amount(), aperture(), negToPos(), and TDoubleRange().

Here is the call graph for this function:

◆ CreateFromIncrement()

static TDoubleRange mrpt::opengl::CAngularObservationMesh::TDoubleRange::CreateFromIncrement	(	double	initial,
		double	final,
		double	increment
	)

inlinestatic

Creates a range of values from the initial value, the final value and the increment.

Exceptions

std::logic_error if the increment is zero.

Definition at line 122 of file CAngularObservationMesh.h.

References increment(), and TDoubleRange().

Here is the call graph for this function:

◆ finalValue()

double mrpt::opengl::CAngularObservationMesh::TDoubleRange::finalValue ( ) const

inline

Returns the last value of the range.

Exceptions

std::logic_error on invalid range type.

Definition at line 195 of file CAngularObservationMesh.h.

Here is the call graph for this function:

◆ increment()

double mrpt::opengl::CAngularObservationMesh::TDoubleRange::increment ( ) const

inline

Returns the increment between two consecutive values of the range.

Exceptions

std::logic_error on invalid range type.

Definition at line 220 of file CAngularObservationMesh.h.

Referenced by CreateFromIncrement().

Here is the caller graph for this function:

◆ initialValue()

double mrpt::opengl::CAngularObservationMesh::TDoubleRange::initialValue ( ) const

inline

Returns the first value of the range.

Exceptions

std::logic_error on invalid range type.

Definition at line 176 of file CAngularObservationMesh.h.

References mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::aperture, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::initial, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode0, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode2, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::negToPos, rangeData, and rangeType.

◆ negToPos()

bool mrpt::opengl::CAngularObservationMesh::TDoubleRange::negToPos ( ) const

inline

Returns the direction of the scan.

True if the increment is positive, false otherwise.

Exceptions

std::logic_error on invalid range type.

Definition at line 277 of file CAngularObservationMesh.h.

References mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::final, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::increment, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::initial, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode0, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode1, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::mode2, mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd::negToPos, rangeData, rangeType, and mrpt::sign().

Referenced by CreateFromAperture(), mrpt::opengl::CAngularObservationMesh::FTrace2D< T >::operator()(), and mrpt::opengl::CAngularObservationMesh::trace1DSetOfRays().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ values()

void CAngularObservationMesh::TDoubleRange::values ( std::vector< double > & vals ) const

Gets a vector with every value in the range.

Exceptions

std::logic_error on invalid range type.

Definition at line 338 of file CAngularObservationMesh.cpp.

Referenced by mrpt::opengl::CAngularObservationMesh::FTrace2D< T >::operator()(), mrpt::opengl::CAngularObservationMesh::trace1DSetOfRays(), and mrpt::opengl::CAngularObservationMesh::trace2DSetOfRays().

Here is the caller graph for this function:

Member Data Documentation

◆ rangeData

union mrpt::opengl::CAngularObservationMesh::TDoubleRange::rd mrpt::opengl::CAngularObservationMesh::TDoubleRange::rangeData

private

Referenced by amount(), aperture(), finalValue(), increment(), initialValue(), negToPos(), and TDoubleRange().

◆ rangeType

char mrpt::opengl::CAngularObservationMesh::TDoubleRange::rangeType

private

Range type.

If 0, it's specified by an initial and a final value, and an increment. If 1, it's specified by an initial and a final value, and a fixed size of samples. If 2, it's specified by an aperture, a fixed size of samples and a boolean variable controlling direction. This type is always zero-centered.

Definition at line 63 of file CAngularObservationMesh.h.

Referenced by amount(), aperture(), finalValue(), increment(), initialValue(), and negToPos().

Detailed Description

Classes

Public Member Functions

Static Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ TDoubleRange() [1/3]

◆ TDoubleRange() [2/3]

◆ TDoubleRange() [3/3]

Member Function Documentation

◆ amount()

◆ aperture()

◆ CreateFromAmount()

◆ CreateFromAperture()

◆ CreateFromIncrement()

◆ finalValue()

◆ increment()

◆ initialValue()

◆ negToPos()

◆ values()

Member Data Documentation

◆ rangeData

◆ rangeType