octomap  1.9.7
octomap::OcTreeNodeStamped Class Reference
+ Inheritance diagram for octomap::OcTreeNodeStamped:
+ Collaboration diagram for octomap::OcTreeNodeStamped:

Public Types

typedef float DataType
 Make the templated data type available from the outside. More...
 

Public Member Functions

void addValue (const float &p)
 adds p to the node's logOdds value (with no boundary / threshold checking!) More...
 
void copyData (const OcTreeDataNode &from)
 Copy the payload (data in "value") from rhs into this node Opposed to copy ctor, this does not clone the children as well. More...
 
void copyData (const OcTreeNodeStamped &from)
 
float getLogOdds () const
 
float getMaxChildLogOdds () const
 
double getMeanChildLogOdds () const
 
double getOccupancy () const
 
unsigned int getTimestamp () const
 
float getValue () const
 
 OCTOMAP_DEPRECATED (bool childExists(unsigned int i) const)
 Test whether the i-th child exists. More...
 
 OCTOMAP_DEPRECATED (bool hasChildren() const)
 
 OcTreeNodeStamped ()
 
 OcTreeNodeStamped (const OcTreeNodeStamped &rhs)
 
bool operator== (const OcTreeDataNode &rhs) const
 Equals operator, compares if the stored value is identical. More...
 
bool operator== (const OcTreeNodeStamped &rhs) const
 
std::istream & readData (std::istream &s)
 Read node payload (data only) from binary stream. More...
 
void setLogOdds (float l)
 sets log odds occupancy of node More...
 
void setTimestamp (unsigned int t)
 
void setValue (float v)
 sets value to be stored in the node More...
 
void updateOccupancyChildren ()
 
void updateTimestamp ()
 
std::ostream & writeData (std::ostream &s) const
 Write node payload (data only) to binary stream. More...
 

Protected Member Functions

void allocChildren ()
 

Protected Attributes

AbstractOcTreeNode ** children
 pointer to array of children, may be NULL More...
 
unsigned int timestamp
 
float value
 stored data (payload) More...
 

Member Typedef Documentation

◆ DataType

typedef float octomap::OcTreeDataNode< float >::DataType
inherited

Make the templated data type available from the outside.

Constructor & Destructor Documentation

◆ OcTreeNodeStamped() [1/2]

octomap::OcTreeNodeStamped::OcTreeNodeStamped ( )
inline

◆ OcTreeNodeStamped() [2/2]

octomap::OcTreeNodeStamped::OcTreeNodeStamped ( const OcTreeNodeStamped rhs)
inline

Member Function Documentation

◆ addValue()

void octomap::OcTreeNode::addValue ( const float &  p)
inherited

adds p to the node's logOdds value (with no boundary / threshold checking!)

References octomap::OcTreeDataNode< float >::value.

◆ allocChildren()

void octomap::OcTreeDataNode< float >::allocChildren
protectedinherited

◆ copyData() [1/2]

void octomap::OcTreeDataNode< float >::copyData ( const OcTreeDataNode< float > &  from)
inherited

Copy the payload (data in "value") from rhs into this node Opposed to copy ctor, this does not clone the children as well.

◆ copyData() [2/2]

void octomap::OcTreeNodeStamped::copyData ( const OcTreeNodeStamped from)
inline

◆ getLogOdds()

float octomap::OcTreeNode::getLogOdds ( ) const
inlineinherited

◆ getMaxChildLogOdds()

float octomap::OcTreeNode::getMaxChildLogOdds ( ) const
inherited
Returns
maximum of children's occupancy probabilities, in log odds

References octomap::OcTreeDataNode< float >::children, and octomap::OcTreeNode::getLogOdds().

Referenced by updateOccupancyChildren(), and octomap::OcTreeNode::updateOccupancyChildren().

◆ getMeanChildLogOdds()

double octomap::OcTreeNode::getMeanChildLogOdds ( ) const
inherited
Returns
mean of all children's occupancy probabilities, in log odds

References octomap::OcTreeDataNode< float >::children, and octomap::OcTreeNode::getOccupancy().

◆ getOccupancy()

double octomap::OcTreeNode::getOccupancy ( ) const
inlineinherited

◆ getTimestamp()

unsigned int octomap::OcTreeNodeStamped::getTimestamp ( ) const
inline

◆ getValue()

float octomap::OcTreeDataNode< float >::getValue ( ) const
inlineinherited
Returns
value stored in the node

◆ OCTOMAP_DEPRECATED() [1/2]

octomap::OcTreeDataNode< float >::OCTOMAP_DEPRECATED ( bool childExists(unsigned int i) const  )
inherited

Test whether the i-th child exists.

Returns
true if the i-th child exists

◆ OCTOMAP_DEPRECATED() [2/2]

octomap::OcTreeDataNode< float >::OCTOMAP_DEPRECATED ( bool hasChildren() const  )
inherited
Returns
true if the node has at least one child

◆ operator==() [1/2]

bool octomap::OcTreeDataNode< float >::operator== ( const OcTreeDataNode< float > &  rhs) const
inherited

Equals operator, compares if the stored value is identical.

◆ operator==() [2/2]

bool octomap::OcTreeNodeStamped::operator== ( const OcTreeNodeStamped rhs) const
inline

◆ readData()

std::istream & octomap::OcTreeDataNode< float >::readData ( std::istream &  s)
inherited

Read node payload (data only) from binary stream.

◆ setLogOdds()

void octomap::OcTreeNode::setLogOdds ( float  l)
inlineinherited

◆ setTimestamp()

void octomap::OcTreeNodeStamped::setTimestamp ( unsigned int  t)
inline

References timestamp.

◆ setValue()

void octomap::OcTreeDataNode< float >::setValue ( v)
inlineinherited

sets value to be stored in the node

◆ updateOccupancyChildren()

void octomap::OcTreeNodeStamped::updateOccupancyChildren ( )
inline

◆ updateTimestamp()

void octomap::OcTreeNodeStamped::updateTimestamp ( )
inline

◆ writeData()

std::ostream & octomap::OcTreeDataNode< float >::writeData ( std::ostream &  s) const
inherited

Write node payload (data only) to binary stream.

Field Documentation

◆ children

AbstractOcTreeNode** octomap::OcTreeDataNode< float >::children
protectedinherited

pointer to array of children, may be NULL

Note
The tree class manages this pointer, the array, and the memory for it! The children of a node are always enforced to be the same type as the node

◆ timestamp

unsigned int octomap::OcTreeNodeStamped::timestamp
protected

◆ value

float octomap::OcTreeDataNode< float >::value
protectedinherited

stored data (payload)


The documentation for this class was generated from the following file: