SurgSim::DataStructures::TreeData Class Referenceabstract

Abstract base class for data stored in a Tree. More...

`#include <SurgSim/DataStructures/TreeData.h>`

Inheritance diagram for SurgSim::DataStructures::TreeData:

## Public Member Functions

| TreeData ()
| Constructor. More...
virtual | ~TreeData ()
| Destructor. More...
bool | operator== (const TreeData &data) const
| If the data are not of the same type, returns false; otherwise, compares with the implementation of isEqual(const TreeData&). More...
bool | operator!= (const TreeData &data) const
| Returns true if the data are not equal; otherwise, returns false. More...

## Private Member Functions

virtual bool | isEqual (const TreeData *data) const =0
| Returns true if the trees are equal; otherwise, returns false. More...

## Detailed Description

Abstract base class for data stored in a Tree.

Each TreeNode has a pointer to a TreeData object.

See also
  TreeNode Tree

## Constructor & Destructor Documentation

## TreeData()

TreeData::TreeData | ( |  | ) |

Constructor.

## ~TreeData()

TreeData::~TreeData | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## isEqual()

virtual bool SurgSim::DataStructures::TreeData::isEqual | ( | const TreeData * | data | ) | const

private pure virtual

Returns true if the trees are equal; otherwise, returns false.

Implement this method in derived classes to do the comparison.

Parameters

  data | Other TreeData for comparison.

Returns
  true if the data are equal; otherwise, returns false.

Implemented in SurgSim::DataStructures::AabbTreeData.

## operator!=()

bool TreeData::operator!= | ( | const TreeData & | data | ) | const

Returns true if the data are not equal; otherwise, returns false.

If the data are not of the same type, returns false; otherwise, compares with the implementation of isEqual(const TreeData&).

Parameters

  data | Other TreeData for comparison.

Returns
  true if the data are equal; otherwise, returns false.

## operator==()

bool TreeData::operator== | ( | const TreeData & | data | ) | const

If the data are not of the same type, returns false; otherwise, compares with the implementation of isEqual(const TreeData&).

Parameters

  data | Other TreeData for comparison.

Returns
  true if the data are equal; otherwise, returns false.

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

- SurgSim/DataStructures/TreeData.h
- SurgSim/DataStructures/TreeData.cpp