Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes
mrpt::detectors::CDetectable3D Class Reference

Detailed Description

Definition at line 79 of file CDetectableObject.h.

#include <mrpt/detectors/CDetectableObject.h>

Inheritance diagram for mrpt::detectors::CDetectable3D:
Inheritance graph

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) noexcept
 
void operator delete[] (void *ptr) noexcept
 
void operator delete (void *memory, void *ptr) noexcept
 
voidoperator new (size_t size, const std::nothrow_t &) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &) noexcept
 
 CDetectable3D ()
 
 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 mxArraywriteToMatlab () 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
mrpt::utils::CObject::Ptr 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 voidoperator new (size_t size, void *ptr)
 

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
void writeToStream (mrpt::utils::CStream &out, int *getVersion) const override
 Introduces a pure virtual method responsible for writing to a CStream. More...
 
void readFromStream (mrpt::utils::CStream &in, int version) override
 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...
 

Static Protected Attributes

RTTI stuff
static mrpt::utils::CLASSINIT _init_CDetectable2D
 

RTTI stuff

using Ptr = std::shared_ptr< CDetectable3D >
 
using ConstPtr = std::shared_ptr< const CDetectable3D >
 
static mrpt::utils::CLASSINIT _init_CDetectable3D
 
static const mrpt::utils::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CDetectable3D"
 
static const mrpt::utils::TRuntimeClassId_GetBaseClass ()
 
static const mrpt::utils::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static mrpt::utils::CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
virtual const mrpt::utils::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::utils::CObjectclone () const override
 Returns a deep copy (clone) of the object, indepently of its class. More...
 

Member Typedef Documentation

◆ ConstPtr

Definition at line 81 of file CDetectableObject.h.

◆ Ptr

A typedef for the associated smart pointer

Definition at line 81 of file CDetectableObject.h.

Constructor & Destructor Documentation

◆ CDetectable3D() [1/3]

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

Definition at line 84 of file CDetectableObject.h.

◆ CDetectable3D() [2/3]

CDetectable3D::CDetectable3D ( const CDetectable2D::Ptr object2d)

Definition at line 28 of file CDetectableObject.cpp.

◆ CDetectable3D() [3/3]

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

Copy pointer content constructor.

Definition at line 89 of file CDetectableObject.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::detectors::CDetectable3D::_GetBaseClass ( )
staticprotected

◆ clone()

virtual mrpt::utils::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 81 of file CDetectableObject.h.

◆ CreateObject()

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

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

◆ GetRuntimeClass()

virtual const mrpt::utils::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::utils::TRuntimeClassId& mrpt::detectors::CDetectable3D::GetRuntimeClassIdStatic ( )
static

◆ operator delete() [1/3]

void mrpt::detectors::CDetectable3D::operator delete ( void ptr)
inlinenoexcept

Definition at line 81 of file CDetectableObject.h.

◆ operator delete() [2/3]

void mrpt::detectors::CDetectable3D::operator delete ( void memory,
void ptr 
)
inlinenoexcept

Definition at line 81 of file CDetectableObject.h.

◆ operator delete() [3/3]

void mrpt::detectors::CDetectable3D::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 81 of file CDetectableObject.h.

◆ operator delete[]()

void mrpt::detectors::CDetectable3D::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 81 of file CDetectableObject.h.

◆ operator new() [1/3]

void* mrpt::detectors::CDetectable3D::operator new ( size_t  size)
inline

Definition at line 81 of file CDetectableObject.h.

◆ operator new() [2/3]

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

Definition at line 81 of file CDetectableObject.h.

◆ operator new() [3/3]

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

Definition at line 81 of file CDetectableObject.h.

◆ operator new[]()

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

Definition at line 81 of file CDetectableObject.h.

◆ readFromStream()

void CDetectable3D::readFromStream ( mrpt::utils::CStream in,
int  version 
)
overrideprotectedvirtual

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
inThe input binary stream where the object data must read from.
versionThe 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::exceptionOn any error, see CStream::ReadBuffer
See also
CStream

Reimplemented from mrpt::detectors::CDetectable2D.

Definition at line 26 of file CDetectableObject.cpp.

◆ setObservation()

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

Definition at line 39 of file CDetectableObject.h.

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

◆ 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 nullptr is class does not support conversion to MATLAB.

Definition at line 89 of file CSerializable.h.

◆ writeToStream()

void CDetectable3D::writeToStream ( mrpt::utils::CStream out,
int *  getVersion 
) const
overrideprotectedvirtual

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
outThe output binary stream where object must be dumped.
getVersionIf nullptr, 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::exceptionOn any error, see CStream::WriteBuffer
See also
CStream

Reimplemented from mrpt::detectors::CDetectable2D.

Definition at line 27 of file CDetectableObject.cpp.

Member Data Documentation

◆ _init_CDetectable2D

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

Definition at line 48 of file CDetectableObject.h.

◆ _init_CDetectable3D

mrpt::utils::CLASSINIT mrpt::detectors::CDetectable3D::_init_CDetectable3D
staticprotected

Definition at line 81 of file CDetectableObject.h.

◆ className

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

Definition at line 81 of file CDetectableObject.h.

◆ m_height

float mrpt::detectors::CDetectable2D::m_height
inherited

Size of detected object.

Definition at line 54 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 34 of file CDetectableObject.h.

◆ m_width

float mrpt::detectors::CDetectable2D::m_width
inherited

Definition at line 54 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 52 of file CDetectableObject.h.

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

◆ m_y

float mrpt::detectors::CDetectable2D::m_y
inherited

◆ m_z

float mrpt::detectors::CDetectable3D::m_z

Z coordinate of detected object.

Definition at line 89 of file CDetectableObject.h.

◆ obs

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

Observation wich contain the deteted object.

Definition at line 37 of file CDetectableObject.h.

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

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::detectors::CDetectable3D::runtimeClassId
staticprotected

Definition at line 81 of file CDetectableObject.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ae4571287 Thu Nov 23 00:06:53 2017 +0100 at dom oct 27 23:51:55 CET 2019