NodeBox< DIM > Class Template Reference

#include <NodeBoxCollection.hpp>

Collaboration diagram for NodeBox< DIM >:

[legend]

List of all members.

Public Member Functions
	NodeBox (c_vector< double, 2 *DIM > minAndMaxValues)
c_vector< double, 2 *DIM > &	rGetMinAndMaxValues ()
void	AddNode (Node< DIM > *pNode)
void	RemoveNode (Node< DIM > *pNode)
std::set< Node< DIM > * > &	rGetNodesContained ()
Private Attributes
c_vector< double, 2 *DIM >	mMinAndMaxValues
std::set< Node< DIM > * >	mNodesContained

---

Detailed Description

template<unsigned DIM>
class NodeBox< DIM >

A small class for a nD 'box' defined by its min/max x/y/z values which contains a list of nodes located in that box

Definition at line 39 of file NodeBoxCollection.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

NodeBox< DIM >::NodeBox

(

c_vector< double, 2 *DIM >

minAndMaxValues

)

[inline]

Constructor just takes in the extremal values of the box.

Parameters:

minAndMaxValues

the extremal values

Definition at line 36 of file NodeBoxCollection.cpp.

References NodeBox< DIM >::mMinAndMaxValues.

---

Member Function Documentation

template<unsigned DIM>

c_vector< double, 2 *DIM > & NodeBox< DIM >::rGetMinAndMaxValues

(

)

[inline]

Get the coordinates of the box, in the form (for 2D) (xmin, xmax, ymin, ymax) (etc).

Definition at line 42 of file NodeBoxCollection.cpp.

References NodeBox< DIM >::mMinAndMaxValues.

template<unsigned DIM>

void NodeBox< DIM >::AddNode

(

Node< DIM > *

pNode

)

[inline]

Add a node to this box.

Parameters:

pNode

address of the node to be added

Definition at line 48 of file NodeBoxCollection.cpp.

References NodeBox< DIM >::mNodesContained.

template<unsigned DIM>

void NodeBox< DIM >::RemoveNode

(

Node< DIM > *

pNode

)

[inline]

Remove a node from this box.

Parameters:

pNode

address of the node to be removed

Definition at line 54 of file NodeBoxCollection.cpp.

References NodeBox< DIM >::mNodesContained.

template<unsigned DIM>

std::set< Node< DIM > * > & NodeBox< DIM >::rGetNodesContained

(

)

[inline]

Get all the nodes in this box.

Definition at line 60 of file NodeBoxCollection.cpp.

References NodeBox< DIM >::mNodesContained.

Referenced by NodeBoxCollection< DIM >::CalculateNodePairs().

---

Member Data Documentation

template<unsigned DIM>

c_vector<double, 2*DIM> NodeBox< DIM >::mMinAndMaxValues [private]

Coordinates of the box, in the form (for 2D) (xmin, xmax, ymin, ymax) (etc).

Definition at line 44 of file NodeBoxCollection.hpp.

Referenced by NodeBox< DIM >::NodeBox(), and NodeBox< DIM >::rGetMinAndMaxValues().

template<unsigned DIM>

std::set< Node<DIM>* > NodeBox< DIM >::mNodesContained [private]

Nodes contained in this box.

Definition at line 47 of file NodeBoxCollection.hpp.

Referenced by NodeBox< DIM >::AddNode(), NodeBox< DIM >::RemoveNode(), and NodeBox< DIM >::rGetNodesContained().

---

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

• /tmp/release_1.1/cancer/src/tissue/NodeBoxCollection.hpp
• /tmp/release_1.1/cancer/src/tissue/NodeBoxCollection.cpp