mrpt::detectors::CDetectable3D Class Reference

Detailed Description

Definition at line 76 of file CDetectableObject.h.

#include <mrpt/detectors/CDetectableObject.h>

Inheritance diagram for mrpt::detectors::CDetectable3D:

Public Member Functions
	CDetectable3D ()=default
	CDetectable3D (const CDetectable2D::Ptr &object2d)
	CDetectable3D (const CDetectable3D *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::CObservation::Ptr 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...
RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr	duplicateGetSmartPtr () const
	Makes a deep copy of the object and returns a smart pointer to it. More...

Public Attributes
float	m_z
	Z coordinate of detected object. More...
float	m_x
	2D Coordinates of detected object More...
float	m_y
float	m_height
	Size of detected object. More...
float	m_width
std::string	m_id
	Must be an unique id for each detectable object. More...
mrpt::obs::CObservation::Ptr	obs
	Observation wich contain the deteted object. 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...
CSerializable virtual methods
virtual void	serializeTo (CSchemeArchiveBase &out) const
	Virtual method for writing (serializing) to an abstract schema based archive. More...
virtual void	serializeFrom (CSchemeArchiveBase &in)
	Virtual method for reading (deserializing) from an abstract schema based archive. More...

Static Protected Attributes
RTTI stuff
static mrpt::rtti::CLASSINIT	_init_CDetectable2D

RTTI stuff
using	Ptr = std::shared_ptr< CDetectable3D >
using	ConstPtr = std::shared_ptr< const CDetectable3D >
using	UniquePtr = std::unique_ptr< CDetectable3D >
using	ConstUniquePtr = std::unique_ptr< const CDetectable3D >
static mrpt::rtti::CLASSINIT	_init_CDetectable3D
static const mrpt::rtti::TRuntimeClassId	runtimeClassId
static constexpr const char *	className = "CDetectable3D"
static const mrpt::rtti::TRuntimeClassId *	_GetBaseClass ()
static constexpr auto	getClassName ()
static const mrpt::rtti::TRuntimeClassId &	GetRuntimeClassIdStatic ()
static std::shared_ptr< CObject >	CreateObject ()
template<typename... Args>
static Ptr	Create (Args &&... args)
template<typename Alloc , typename... Args>
static Ptr	CreateAlloc (const Alloc &alloc, 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::detectors::CDetectable3D::ConstPtr = std::shared_ptr<const CDetectable3D >

Definition at line 78 of file CDetectableObject.h.

ConstUniquePtr

using mrpt::detectors::CDetectable3D::ConstUniquePtr = std::unique_ptr<const CDetectable3D >

Definition at line 78 of file CDetectableObject.h.

Ptr

using mrpt::detectors::CDetectable3D::Ptr = std::shared_ptr< CDetectable3D >

A type for the associated smart pointer

Definition at line 78 of file CDetectableObject.h.

UniquePtr

using mrpt::detectors::CDetectable3D::UniquePtr = std::unique_ptr< CDetectable3D >

Definition at line 78 of file CDetectableObject.h.

Constructor & Destructor Documentation

CDetectable3D() [1/3]

mrpt::detectors::CDetectable3D::CDetectable3D ( )

default

CDetectable3D() [2/3]

CDetectable3D::CDetectable3D

(

const CDetectable2D::Ptr &

object2d

)

Definition at line 35 of file CDetectableObject.cpp.

CDetectable3D() [3/3]

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

inline

Copy pointer content constructor.

Definition at line 86 of file CDetectableObject.h.

Member Function Documentation

_GetBaseClass()

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

staticprotected

clone()

virtual mrpt::rtti::CObject* mrpt::detectors::CDetectable3D::clone ( ) const

overridevirtual

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

Reimplemented from mrpt::detectors::CDetectable2D.

Create()

template<typename... Args>

static Ptr mrpt::detectors::CDetectable3D::Create ( Args &&...  args )

inlinestatic

Definition at line 78 of file CDetectableObject.h.

CreateAlloc()

template<typename Alloc , typename... Args>

static Ptr mrpt::detectors::CDetectable3D::CreateAlloc ( const Alloc &  alloc, Args &&...  args  )

inlinestatic

Definition at line 78 of file CDetectableObject.h.

CreateObject()

static std::shared_ptr<CObject> mrpt::detectors::CDetectable3D::CreateObject ( )

static

CreateUnique()

template<typename... Args>

static UniquePtr mrpt::detectors::CDetectable3D::CreateUnique ( Args &&...  args )

inlinestatic

Definition at line 78 of file CDetectableObject.h.

distanceTo()

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

inlineinherited

Compute distance between centers of two detectable 2D objects.

Returns

calculated distance.

Definition at line 64 of file CDetectableObject.h.

References mrpt::detectors::CDetectable2D::m_height, mrpt::detectors::CDetectable2D::m_width, mrpt::detectors::CDetectable2D::m_x, and mrpt::detectors::CDetectable2D::m_y.

duplicateGetSmartPtr()

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

inlineinherited

Makes a deep copy of the object and returns a smart pointer to it.

Definition at line 200 of file CObject.h.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getClassName()

static constexpr auto mrpt::detectors::CDetectable3D::getClassName ( )

inlinestatic

Definition at line 78 of file CDetectableObject.h.

GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::detectors::CDetectable3D::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::detectors::CDetectable2D.

GetRuntimeClassIdStatic()

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

static

serializeFrom() [1/2]

virtual void mrpt::serialization::CSerializable::serializeFrom ( CSchemeArchiveBase &  in )

inlineprotectedvirtualinherited

Virtual method for reading (deserializing) from an abstract schema based archive.

Definition at line 74 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

serializeFrom() [2/2]

void CDetectable3D::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

Reimplemented from mrpt::detectors::CDetectable2D.

Definition at line 29 of file CDetectableObject.cpp.

serializeGetVersion()

uint8_t CDetectable3D::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.

Reimplemented from mrpt::detectors::CDetectable2D.

Definition at line 33 of file CDetectableObject.cpp.

serializeTo() [1/2]

virtual void mrpt::serialization::CSerializable::serializeTo ( CSchemeArchiveBase &  out ) const

inlineprotectedvirtualinherited

Virtual method for writing (serializing) to an abstract schema based archive.

Definition at line 64 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

serializeTo() [2/2]

void CDetectable3D::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

Reimplemented from mrpt::detectors::CDetectable2D.

Definition at line 34 of file CDetectableObject.cpp.

setObservation()

void mrpt::detectors::CDetectableObject::setObservation ( mrpt::obs::CObservation::Ptr  newObs )

inlineinherited

Definition at line 36 of file CDetectableObject.h.

References mrpt::detectors::CDetectableObject::obs.

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 90 of file CSerializable.h.

Member Data Documentation

_init_CDetectable2D

mrpt::rtti::CLASSINIT mrpt::detectors::CDetectable2D::_init_CDetectable2D

staticprotectedinherited

Definition at line 45 of file CDetectableObject.h.

_init_CDetectable3D

mrpt::rtti::CLASSINIT mrpt::detectors::CDetectable3D::_init_CDetectable3D

staticprotected

Definition at line 78 of file CDetectableObject.h.

className

constexpr const char* mrpt::detectors::CDetectable3D::className = "CDetectable3D"

static

Definition at line 78 of file CDetectableObject.h.

m_height

float mrpt::detectors::CDetectable2D::m_height

inherited

Size of detected object.

Definition at line 51 of file CDetectableObject.h.

Referenced by mrpt::detectors::CDetectable2D::distanceTo().

m_id

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

inherited

Must be an unique id for each detectable object.

Definition at line 31 of file CDetectableObject.h.

m_width

float mrpt::detectors::CDetectable2D::m_width

inherited

Definition at line 51 of file CDetectableObject.h.

Referenced by mrpt::detectors::CDetectable2D::distanceTo().

m_x

float mrpt::detectors::CDetectable2D::m_x

inherited

2D Coordinates of detected object

Definition at line 49 of file CDetectableObject.h.

Referenced by mrpt::detectors::CDetectable2D::distanceTo().

m_y

float mrpt::detectors::CDetectable2D::m_y

inherited

Definition at line 49 of file CDetectableObject.h.

Referenced by mrpt::detectors::CDetectable2D::distanceTo().

m_z

float mrpt::detectors::CDetectable3D::m_z

Z coordinate of detected object.

Definition at line 86 of file CDetectableObject.h.

obs

mrpt::obs::CObservation::Ptr mrpt::detectors::CDetectableObject::obs

inherited

Observation wich contain the deteted object.

Definition at line 34 of file CDetectableObject.h.

Referenced by mrpt::detectors::CDetectableObject::setObservation().

runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::detectors::CDetectable3D::runtimeClassId

staticprotected

Definition at line 78 of file CDetectableObject.h.