mrpt::opengl::CAngularObservationMesh::TDoubleRange Struct Reference

Detailed Description

Range specification type, with several uses.

Definition at line 46 of file CAngularObservationMesh.h.

#include <mrpt/opengl/CAngularObservationMesh.h>

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

Public Member Functions
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 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...

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  )

inlineprivate

Constructor from initial value, final value and range.

Definition at line 79 of file CAngularObservationMesh.h.

TDoubleRange() [2/3]

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

inlineprivate

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

Definition at line 87 of file CAngularObservationMesh.h.

TDoubleRange() [3/3]

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

inlineprivate

Constructor from aperture, amount of samples and scan direction.

Definition at line 95 of file CAngularObservationMesh.h.

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 173 of file CAngularObservationMesh.h.

References mrpt::mrpt::utils::sign().

Referenced by mrpt::opengl::CAngularObservationMesh::trace1DSetOfRays().

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 125 of file CAngularObservationMesh.h.

References mrpt::mrpt::utils::sign().

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

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 112 of file CAngularObservationMesh.h.

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 118 of file CAngularObservationMesh.h.

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 105 of file CAngularObservationMesh.h.

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 149 of file CAngularObservationMesh.h.

References mrpt::mrpt::utils::sign().

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 161 of file CAngularObservationMesh.h.

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 137 of file CAngularObservationMesh.h.

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 190 of file CAngularObservationMesh.h.

References mrpt::mrpt::utils::sign().

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

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 275 of file CAngularObservationMesh.cpp.

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

Member Data Documentation

rangeData

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

private

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 54 of file CAngularObservationMesh.h.