Detailed Description

Kinematic model for.

Definition at line 21 of file CVehicleVelCmd_Holo.h.

#include <mrpt/kinematics/CVehicleVelCmd_Holo.h>

Inheritance diagram for mrpt::kinematics::CVehicleVelCmd_Holo:

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) noexcept

void	operator delete[] (void *ptr) noexcept

void	operator delete (void memory, void ptr) noexcept

void *	operator new (size_t size, const std::nothrow_t &) noexcept

void	operator delete (void *ptr, const std::nothrow_t &) noexcept

	CVehicleVelCmd_Holo ()

	CVehicleVelCmd_Holo (double vel, double dir_local, double ramp_time, double rot_speed)

virtual	~CVehicleVelCmd_Holo ()

size_t	getVelCmdLength () const override
	Get number of components in each velocity command. More...

std::string	getVelCmdDescription (const int index) const override
	Get textual, human-readable description of each velocity command component. More...

double	getVelCmdElement (const int index) const override
	Get each velocity command component. More...

void	setVelCmdElement (const int index, const double val) override
	Set each velocity command component. More...

bool	isStopCmd () const override
	Returns true if the command means "do not move" / "stop". More...

void	setToStop () override
	Set to a command that means "do not move" / "stop". More...

void	cmdVel_scale (double vel_scale) override
	Scale the velocity command encoded in this object. More...

double	cmdVel_limits (const mrpt::kinematics::CVehicleVelCmd &prev_vel_cmd, const double beta, const TVelCmdParams &params) override
	Updates this command, computing a blended version of `beta` (within [0,1]) of `vel_cmd` and `1-beta` of `prev_vel_cmd`, simultaneously to honoring any user-side maximum velocities. More...

std::string	asString () const
	Returns a human readable description of the cmd. More...

virtual mxArray *	writeToMatlab () const
	Introduces a pure virtual method responsible for writing to a `mxArray` Matlab object, typically a MATLAB `struct` whose contents are documented in each derived class. More...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

Public Attributes
double	vel
	speed(m / s) More...

double	dir_local
	: direction, relative to the current robot heading (radians). More...

double	ramp_time
	: Blending time between current and target time. More...

double	rot_speed
	: (rad/s) rotational speed for rotating such as the robot slowly faces forward. More...

Protected Member Functions
CSerializable virtual methods
uint8_t	serializeGetVersion () const override
	Must return the current versioning number of the object. More...

void	serializeTo (mrpt::serialization::CArchive &out) const override
	Pure virtual method for writing (serializing) to an abstract archive. More...

void	serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
	Pure virtual method for reading (deserializing) from an abstract archive. More...

RTTI stuff

using	Ptr = std::shared_ptr< CVehicleVelCmd_Holo >

using	ConstPtr = std::shared_ptr< const CVehicleVelCmd_Holo >

using	UniquePtr = std::unique_ptr< CVehicleVelCmd_Holo >

using	ConstUniquePtr = std::unique_ptr< const CVehicleVelCmd_Holo >

static mrpt::rtti::CLASSINIT	_init_CVehicleVelCmd_Holo

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CVehicleVelCmd_Holo"

static const mrpt::rtti::TRuntimeClassId *	_GetBaseClass ()

static constexpr auto	getClassName ()

static const mrpt::rtti::TRuntimeClassId &	GetRuntimeClassIdStatic ()

static mrpt::rtti::CObject *	CreateObject ()

template<typename... Args>
static Ptr	Create (Args &&... args)

template<typename... Args>
static UniquePtr	CreateUnique (Args &&... args)

virtual const mrpt::rtti::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...

virtual mrpt::rtti::CObject *	clone () const override
	Returns a deep copy (clone) of the object, indepently of its class. More...

Member Typedef Documentation

◆ ConstPtr

using mrpt::kinematics::CVehicleVelCmd_Holo::ConstPtr = std::shared_ptr<const CVehicleVelCmd_Holo >

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ ConstUniquePtr

using mrpt::kinematics::CVehicleVelCmd_Holo::ConstUniquePtr = std::unique_ptr<const CVehicleVelCmd_Holo >

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ Ptr

using mrpt::kinematics::CVehicleVelCmd_Holo::Ptr = std::shared_ptr< CVehicleVelCmd_Holo >

A type for the associated smart pointer

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ UniquePtr

using mrpt::kinematics::CVehicleVelCmd_Holo::UniquePtr = std::unique_ptr< CVehicleVelCmd_Holo >

Definition at line 23 of file CVehicleVelCmd_Holo.h.

Constructor & Destructor Documentation

◆ CVehicleVelCmd_Holo() [1/2]

CVehicleVelCmd_Holo::CVehicleVelCmd_Holo ( )

Definition at line 18 of file CVehicleVelCmd_Holo.cpp.

◆ CVehicleVelCmd_Holo() [2/2]

CVehicleVelCmd_Holo::CVehicleVelCmd_Holo	(	double	vel,
		double	dir_local,
		double	ramp_time,
		double	rot_speed
	)

Definition at line 23 of file CVehicleVelCmd_Holo.cpp.

◆ ~CVehicleVelCmd_Holo()

CVehicleVelCmd_Holo::~CVehicleVelCmd_Holo ( )

virtual

Definition at line 32 of file CVehicleVelCmd_Holo.cpp.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::kinematics::CVehicleVelCmd_Holo::_GetBaseClass ( )

staticprotected

◆ asString()

std::string mrpt::kinematics::CVehicleVelCmd::asString ( ) const

inherited

Returns a human readable description of the cmd.

Definition at line 21 of file CVehicleVelCmd.cpp.

References mrpt::format().

◆ clone()

virtual mrpt::rtti::CObject* mrpt::kinematics::CVehicleVelCmd_Holo::clone ( ) const

overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::rtti::CObject.

◆ cmdVel_limits()

double CVehicleVelCmd_Holo::cmdVel_limits	(	const mrpt::kinematics::CVehicleVelCmd &	prev_vel_cmd,
		const double	beta,
		const TVelCmdParams &	params
	)

overridevirtual

Updates this command, computing a blended version of beta (within [0,1]) of vel_cmd and 1-beta of prev_vel_cmd, simultaneously to honoring any user-side maximum velocities.

Returns: The [0,1] ratio that the cmdvel had to be scaled down, or 1.0 if none.

Implements mrpt::kinematics::CVehicleVelCmd.

Definition at line 134 of file CVehicleVelCmd_Holo.cpp.

References ASSERTMSG_, rot_speed, and vel.

◆ cmdVel_scale()

void CVehicleVelCmd_Holo::cmdVel_scale ( double vel_scale )

overridevirtual

Scale the velocity command encoded in this object.

Parameters

[in]	vel_scale	A scale within [0,1] reflecting how much should be the raw velocity command be lessen (e.g. for safety reasons,...).
[out]	out_vel_cmd	Users can directly inherit from existing implementations instead of manually redefining this method: mrpt::kinematics::CVehicleVelCmd_DiffDriven mrpt::kinematics::CVehicleVelCmd_Holo

Implements mrpt::kinematics::CVehicleVelCmd.

Definition at line 125 of file CVehicleVelCmd_Holo.cpp.

References vel.

◆ Create()

template<typename... Args>

static Ptr mrpt::kinematics::CVehicleVelCmd_Holo::Create ( Args &&... args )

inlinestatic

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ CreateObject()

static mrpt::rtti::CObject* mrpt::kinematics::CVehicleVelCmd_Holo::CreateObject ( )

static

◆ CreateUnique()

template<typename... Args>

static UniquePtr mrpt::kinematics::CVehicleVelCmd_Holo::CreateUnique ( Args &&... args )

inlinestatic

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 169 of file CObject.h.

References mrpt::rtti::CObject::clone().

Referenced by mrpt::obs::CRawlog::addActions(), and mrpt::obs::CRawlog::addObservations().

◆ getClassName()

static constexpr auto mrpt::kinematics::CVehicleVelCmd_Holo::getClassName ( )

inlinestaticconstexpr

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::kinematics::CVehicleVelCmd_Holo::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::kinematics::CVehicleVelCmd.

◆ GetRuntimeClassIdStatic()

static const mrpt::rtti::TRuntimeClassId& mrpt::kinematics::CVehicleVelCmd_Holo::GetRuntimeClassIdStatic ( )

static

◆ getVelCmdDescription()

std::string CVehicleVelCmd_Holo::getVelCmdDescription ( const int index ) const

overridevirtual

Get textual, human-readable description of each velocity command component.

Implements mrpt::kinematics::CVehicleVelCmd.

Definition at line 34 of file CVehicleVelCmd_Holo.cpp.

References THROW_EXCEPTION_FMT.

◆ getVelCmdElement()

double CVehicleVelCmd_Holo::getVelCmdElement ( const int index ) const

overridevirtual

Get each velocity command component.

Implements mrpt::kinematics::CVehicleVelCmd.

Definition at line 55 of file CVehicleVelCmd_Holo.cpp.

References dir_local, ramp_time, rot_speed, THROW_EXCEPTION_FMT, and vel.

◆ getVelCmdLength()

size_t CVehicleVelCmd_Holo::getVelCmdLength ( ) const

overridevirtual

Get number of components in each velocity command.

Implements mrpt::kinematics::CVehicleVelCmd.

Definition at line 33 of file CVehicleVelCmd_Holo.cpp.

◆ isStopCmd()

bool CVehicleVelCmd_Holo::isStopCmd ( ) const

overridevirtual

Returns true if the command means "do not move" / "stop".

See also: setToStop

Implements mrpt::kinematics::CVehicleVelCmd.

Definition at line 97 of file CVehicleVelCmd_Holo.cpp.

References rot_speed, and vel.

◆ operator delete() [1/3]

void mrpt::kinematics::CVehicleVelCmd_Holo::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ operator delete() [2/3]

void mrpt::kinematics::CVehicleVelCmd_Holo::operator delete ( void * ptr )

inlinenoexcept

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ operator delete() [3/3]

void mrpt::kinematics::CVehicleVelCmd_Holo::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ operator delete[]()

void mrpt::kinematics::CVehicleVelCmd_Holo::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ operator new() [1/3]

void* mrpt::kinematics::CVehicleVelCmd_Holo::operator new ( size_t size )

inline

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ operator new() [2/3]

void* mrpt::kinematics::CVehicleVelCmd_Holo::operator new	(	size_t	size,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ operator new() [3/3]

static void* mrpt::kinematics::CVehicleVelCmd_Holo::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ operator new[]()

void* mrpt::kinematics::CVehicleVelCmd_Holo::operator new[] ( size_t size )

inline

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ serializeFrom()

void CVehicleVelCmd_Holo::serializeFrom	(	mrpt::serialization::CArchive &	in,
		uint8_t	serial_version
	)

overrideprotectedvirtual

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

Parameters

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions

std::exception On any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 106 of file CVehicleVelCmd_Holo.cpp.

References dir_local, MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, ramp_time, rot_speed, and vel.

◆ serializeGetVersion()

uint8_t CVehicleVelCmd_Holo::serializeGetVersion ( ) const

overrideprotectedvirtual

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Implements mrpt::serialization::CSerializable.

Definition at line 119 of file CVehicleVelCmd_Holo.cpp.

◆ serializeTo()

void CVehicleVelCmd_Holo::serializeTo ( mrpt::serialization::CArchive & out ) const

overrideprotectedvirtual

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions

std::exception On any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 120 of file CVehicleVelCmd_Holo.cpp.

References dir_local, ramp_time, rot_speed, and vel.

◆ setToStop()

void CVehicleVelCmd_Holo::setToStop ( )

overridevirtual

Set to a command that means "do not move" / "stop".

See also: isStopCmd

Implements mrpt::kinematics::CVehicleVelCmd.

Definition at line 102 of file CVehicleVelCmd_Holo.cpp.

References dir_local, ramp_time, rot_speed, and vel.

◆ setVelCmdElement()

void CVehicleVelCmd_Holo::setVelCmdElement	(	const int	index,
		const double	val
	)

overridevirtual

Set each velocity command component.

Implements mrpt::kinematics::CVehicleVelCmd.

Definition at line 76 of file CVehicleVelCmd_Holo.cpp.

References dir_local, ramp_time, rot_speed, THROW_EXCEPTION_FMT, val, and vel.

◆ writeToMatlab()

virtual mxArray* mrpt::serialization::CSerializable::writeToMatlab ( ) const

inlinevirtualinherited

Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class.

Returns: A new mxArray (caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB.

Definition at line 70 of file CSerializable.h.

Member Data Documentation

◆ _init_CVehicleVelCmd_Holo

mrpt::rtti::CLASSINIT mrpt::kinematics::CVehicleVelCmd_Holo::_init_CVehicleVelCmd_Holo

staticprotected

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ className

constexpr const char* mrpt::kinematics::CVehicleVelCmd_Holo::className = "CVehicleVelCmd_Holo"

staticconstexpr

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ dir_local

double mrpt::kinematics::CVehicleVelCmd_Holo::dir_local

: direction, relative to the current robot heading (radians).

0 means forward.

Definition at line 29 of file CVehicleVelCmd_Holo.h.

Referenced by mrpt::nav::CPTG_Holo_Blend::directionToMotionCommand(), getVelCmdElement(), mrpt::kinematics::CVehicleSimul_Holo::sendVelCmd(), serializeFrom(), serializeTo(), setToStop(), and setVelCmdElement().

◆ ramp_time

double mrpt::kinematics::CVehicleVelCmd_Holo::ramp_time

: Blending time between current and target time.

Definition at line 31 of file CVehicleVelCmd_Holo.h.

Referenced by mrpt::nav::CPTG_Holo_Blend::directionToMotionCommand(), getVelCmdElement(), mrpt::kinematics::CVehicleSimul_Holo::sendVelCmd(), serializeFrom(), serializeTo(), setToStop(), and setVelCmdElement().

◆ rot_speed

double mrpt::kinematics::CVehicleVelCmd_Holo::rot_speed

: (rad/s) rotational speed for rotating such as the robot slowly faces forward.

Definition at line 34 of file CVehicleVelCmd_Holo.h.

Referenced by cmdVel_limits(), mrpt::nav::CPTG_Holo_Blend::directionToMotionCommand(), getVelCmdElement(), isStopCmd(), mrpt::kinematics::CVehicleSimul_Holo::sendVelCmd(), serializeFrom(), serializeTo(), setToStop(), and setVelCmdElement().

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::kinematics::CVehicleVelCmd_Holo::runtimeClassId

staticprotected

Definition at line 23 of file CVehicleVelCmd_Holo.h.

◆ vel

double mrpt::kinematics::CVehicleVelCmd_Holo::vel

speed(m / s)

Definition at line 26 of file CVehicleVelCmd_Holo.h.

Referenced by cmdVel_limits(), cmdVel_scale(), mrpt::nav::CPTG_Holo_Blend::directionToMotionCommand(), getVelCmdElement(), isStopCmd(), mrpt::kinematics::CVehicleSimul_Holo::sendVelCmd(), serializeFrom(), serializeTo(), setToStop(), and setVelCmdElement().

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ ConstUniquePtr

◆ Ptr

◆ UniquePtr

Constructor & Destructor Documentation

◆ CVehicleVelCmd_Holo() [1/2]

◆ CVehicleVelCmd_Holo() [2/2]

◆ ~CVehicleVelCmd_Holo()

Member Function Documentation

◆ _GetBaseClass()

◆ asString()

◆ clone()

◆ cmdVel_limits()

◆ cmdVel_scale()

◆ Create()

◆ CreateObject()

◆ CreateUnique()

◆ duplicateGetSmartPtr()

◆ getClassName()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ getVelCmdDescription()

◆ getVelCmdElement()

◆ getVelCmdLength()

◆ isStopCmd()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ serializeFrom()

◆ serializeGetVersion()

◆ serializeTo()

◆ setToStop()

◆ setVelCmdElement()

◆ writeToMatlab()

Member Data Documentation

◆ _init_CVehicleVelCmd_Holo

◆ className

◆ dir_local

◆ ramp_time

◆ rot_speed

◆ runtimeClassId

◆ vel