Detailed Description

Definition at line 49 of file CDetectableObject.h.

#include <mrpt/detectors/CDetectableObject.h>

Inheritance diagram for mrpt::detectors::CDetectable2D:

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) throw ()

void	operator delete[] (void *ptr) throw ()

void	operator delete (void memory, void ptr) throw ()

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

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

	CDetectable2D (const int &x=0, const int &y=0, const int &height=0, const int &width=0)
	Extra constructor. More...

	CDetectable2D (const CDetectable2D *d)
	Copy pointer content constructor. More...

double	distanceTo (const CDetectable2D &d2)
	Compute distance between centers of two detectable 2D objects. More...

void	setObservation (mrpt::obs::CObservationPtr newObs)

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...

CObject *	clone () const
	Cloning interface for smart pointers. More...

RTTI classes and functions
mrpt::utils::CObjectPtr	duplicateGetSmartPtr () const
	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). More...

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

Public Attributes
float	m_x

float	m_y
	2D Coordinates of detected object More...

float	m_height

float	m_width
	Size of detected object. More...

std::string	m_id
	Must be an unique id for each detectable object. More...

mrpt::obs::CObservationPtr	obs
	Observation wich contain the deteted object. More...

Static Public Attributes
static const mrpt::utils::TRuntimeClassId	classCObject

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCDetectableObject

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const
	Introduces a pure virtual method responsible for writing to a CStream. More...

void	readFromStream (mrpt::utils::CStream &in, int version)
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...

RTTI stuff
typedef CDetectable2DPtr	Ptr

typedef CDetectable2DPtr	ConstPtr

static mrpt::utils::CLASSINIT	_init_CDetectable2D

static mrpt::utils::TRuntimeClassId	classCDetectable2D

static const mrpt::utils::TRuntimeClassId *	classinfo

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

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

virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class. More...

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

static CDetectable2DPtr	Create ()

Member Typedef Documentation

◆ ConstPtr

typedef CDetectable2DPtr mrpt::detectors::CDetectable2D::ConstPtr

Definition at line 51 of file CDetectableObject.h.

◆ Ptr

typedef CDetectable2DPtr mrpt::detectors::CDetectable2D::Ptr

A typedef for the associated smart pointer

Definition at line 51 of file CDetectableObject.h.

Constructor & Destructor Documentation

◆ CDetectable2D() [1/2]

mrpt::detectors::CDetectable2D::CDetectable2D	(	const int &	x = `0`,
		const int &	y = `0`,
		const int &	height = `0`,
		const int &	width = `0`
	)

inline

Extra constructor.

Definition at line 59 of file CDetectableObject.h.

◆ CDetectable2D() [2/2]

mrpt::detectors::CDetectable2D::CDetectable2D ( const CDetectable2D * d )

inline

Copy pointer content constructor.

Definition at line 64 of file CDetectableObject.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::detectors::CDetectable2D::_GetBaseClass ( )

staticprotected

◆ clone()

CObject* mrpt::utils::CObject::clone ( ) const

inlineinherited

Cloning interface for smart pointers.

Definition at line 133 of file CObject.h.

◆ Create()

static CDetectable2DPtr mrpt::detectors::CDetectable2D::Create ( )

static

◆ CreateObject()

static mrpt::utils::CObject* mrpt::detectors::CDetectable2D::CreateObject ( )

static

◆ distanceTo()

double mrpt::detectors::CDetectable2D::distanceTo ( const CDetectable2D & d2 )

inline

Compute distance between centers of two detectable 2D objects.

Returns: calculated distance.

Definition at line 72 of file CDetectableObject.h.

References m_height, m_width, m_x, and m_y.

◆ duplicate()

virtual mrpt::utils::CObject* mrpt::detectors::CDetectable2D::duplicate ( ) const

virtual

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

Reimplemented in mrpt::detectors::CDetectable3D.

◆ duplicateGetSmartPtr()

mrpt::utils::CObjectPtr 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 162 of file CObject.h.

References mrpt::utils::CObjectPtr.

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

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::detectors::CDetectable2D::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::detectors::CDetectableObject.

Reimplemented in mrpt::detectors::CDetectable3D.

◆ operator delete() [1/3]

void mrpt::detectors::CDetectable2D::operator delete	(	void *	ptr	)
throw	(
	)

inline

Definition at line 51 of file CDetectableObject.h.

◆ operator delete() [2/3]

void mrpt::detectors::CDetectable2D::operator delete	(	void *	memory,
		void *	ptr
	)
throw	(
	)

inline

Definition at line 51 of file CDetectableObject.h.

◆ operator delete() [3/3]

void mrpt::detectors::CDetectable2D::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 51 of file CDetectableObject.h.

◆ operator delete[]()

void mrpt::detectors::CDetectable2D::operator delete[]	(	void *	ptr	)
throw	(
	)

inline

Definition at line 51 of file CDetectableObject.h.

◆ operator new() [1/3]

static void* mrpt::detectors::CDetectable2D::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 51 of file CDetectableObject.h.

◆ operator new() [2/3]

void* mrpt::detectors::CDetectable2D::operator new ( size_t size )

inline

Definition at line 51 of file CDetectableObject.h.

◆ operator new() [3/3]

void* mrpt::detectors::CDetectable2D::operator new	(	size_t	size,
		const std::nothrow_t &
	)
throw	(
	)

inline

Definition at line 51 of file CDetectableObject.h.

◆ operator new[]()

void* mrpt::detectors::CDetectable2D::operator new[] ( size_t size )

inline

Definition at line 51 of file CDetectableObject.h.

◆ readFromStream()

void CDetectable2D::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

protectedvirtual

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

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 error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Reimplemented in mrpt::detectors::CDetectable3D.

Definition at line 24 of file CDetectableObject.cpp.

◆ setObservation()

void mrpt::detectors::CDetectableObject::setObservation ( mrpt::obs::CObservationPtr newObs )

inlineinherited

Definition at line 41 of file CDetectableObject.h.

◆ writeToMatlab()

virtual mxArray* mrpt::utils::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 NULL is class does not support conversion to MATLAB.

Definition at line 79 of file CSerializable.h.

◆ writeToStream()

void CDetectable2D::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

protectedvirtual

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters

out	The output binary stream where object must be dumped.
getVersion	If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Reimplemented in mrpt::detectors::CDetectable3D.

Definition at line 28 of file CDetectableObject.cpp.

Member Data Documentation

◆ _init_CDetectable2D

mrpt::utils::CLASSINIT mrpt::detectors::CDetectable2D::_init_CDetectable2D

staticprotected

Definition at line 51 of file CDetectableObject.h.

◆ classCDetectable2D

mrpt::utils::TRuntimeClassId mrpt::detectors::CDetectable2D::classCDetectable2D

static

Definition at line 51 of file CDetectableObject.h.

◆ classCDetectableObject

const mrpt::utils::TRuntimeClassId mrpt::detectors::CDetectableObject::classCDetectableObject

staticinherited

Definition at line 33 of file CDetectableObject.h.

◆ classCObject

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 118 of file CObject.h.

◆ classCSerializable

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 42 of file CSerializable.h.

◆ classinfo

const mrpt::utils::TRuntimeClassId* mrpt::detectors::CDetectable2D::classinfo

static

Definition at line 51 of file CDetectableObject.h.

◆ m_height

float mrpt::detectors::CDetectable2D::m_height

Definition at line 56 of file CDetectableObject.h.

Referenced by distanceTo().

◆ m_id

std::string mrpt::detectors::CDetectableObject::m_id

inherited

Must be an unique id for each detectable object.

Definition at line 37 of file CDetectableObject.h.

◆ m_width

float mrpt::detectors::CDetectable2D::m_width

Size of detected object.

Definition at line 56 of file CDetectableObject.h.

Referenced by distanceTo().

◆ m_x

float mrpt::detectors::CDetectable2D::m_x

Definition at line 55 of file CDetectableObject.h.

Referenced by distanceTo().

◆ m_y

float mrpt::detectors::CDetectable2D::m_y

2D Coordinates of detected object

Definition at line 55 of file CDetectableObject.h.

Referenced by distanceTo().

◆ obs

mrpt::obs::CObservationPtr mrpt::detectors::CDetectableObject::obs

inherited

Observation wich contain the deteted object.

Definition at line 39 of file CDetectableObject.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CDetectable2D() [1/2]

◆ CDetectable2D() [2/2]

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ distanceTo()

◆ duplicate()

◆ duplicateGetSmartPtr()

◆ GetRuntimeClass()

◆ 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[]()

◆ readFromStream()

◆ setObservation()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CDetectable2D

◆ classCDetectable2D

◆ classCDetectableObject

◆ classCObject

◆ classCSerializable

◆ classinfo

◆ m_height

◆ m_id

◆ m_width

◆ m_x

◆ m_y

◆ obs