afl::BoundaryTree_4 Class Reference

#include <boundarytree_4.h>

Inheritance diagram for afl::BoundaryTree_4:

List of all members.

Public Member Functions
	BoundaryTree_4 (const Field *field)
virtual	~BoundaryTree_4 ()
virtual troolean	locate (const Point &p) const
virtual data_t	intersect (const Point &p, const Point &v) const
virtual void	addSegment (const Point &from, const Point &to)
virtual void	addSegment (const Field *field)
virtual Point	getBoundingBoxMin () const
virtual Point	getBoundingBoxMax () const
virtual void	toXML (std::ostream &doc, const std::string &componentsDir, const std::string &baseURI) const
virtual Boundary *	clone ()
virtual bool	hasNoSegments () const
virtual Point	findNearest (const Point &p) const
virtual Value	getNormal (const Point &p) const
Protected Attributes
std::list< Boundary_4 >	_segments

---

Detailed Description

Class BoundaryTree_4D A 4D boundary.

---

Constructor & Destructor Documentation

afl::BoundaryTree_4::BoundaryTree_4 (  const Field *  field  )

Parameters: field  the field this boundary bounds

virtual afl::BoundaryTree_4::~BoundaryTree_4 (   )  [virtual]

desructor is virtual

---

Member Function Documentation

virtual void afl::BoundaryTree_4::addSegment (  const Field *  field  )  [virtual]

adds a segment of the opposite colour. Parameters: field  a field of the appropriate dimensions to define the new boundary section Exceptions: ddf::GeometryException  is thrown if the new segment has no hyper-volume ddf::InvalidArgumentException  is thrown if the new segment overlaps an existing segment or if the new segment is not of the right dimension/value. Implements afl::Boundary.

virtual void afl::BoundaryTree_4::addSegment (  const Point &  from, const Point &  to )  [virtual]

adds a segment of the opposite colour. Parameters: from  one hyper corner of the new rectangular segment to  the opposite hyper-corner of the new rectangular segment Exceptions: ddf::GeometryException  is thrown if the new segment has no hyper-volume ddf::InvalidArgumentException  is thrown if the new segment overlaps an existing segment or if the new segment is not of the right dimension. Implements afl::Boundary.

virtual Boundary* afl::BoundaryTree_4::clone (   )  [virtual]

Returns: a newly created and exact copy of the object Implements afl::Boundary.

virtual Point afl::BoundaryTree_4::findNearest (  const Point &  p  )  const [virtual]

finds the nearest point on the boundary to a point. Parameters: p  the point to find the nearest point of Returns: the nearest point to p that is on the boundary. If p is on the boundary, then p itself is returned. Implements afl::Boundary.

virtual Point afl::BoundaryTree_4::getBoundingBoxMax (   )  const [virtual]

Returns: the largest point in the boundary. In a simple boundary, this is a point with the largest value of X, Y, Z and T. In a field boundary this is the point that corresponds to field's boundary's largest point Implements afl::Boundary.

virtual Point afl::BoundaryTree_4::getBoundingBoxMin (   )  const [virtual]

Returns: the smallest point in the boundary. In a simple boundary, this is a point with the smallest value of X, Y, Z and T. In a field boundary this is the point that corresponds to field's boundary's smallest point Implements afl::Boundary.

virtual Value afl::BoundaryTree_4::getNormal (  const Point &  p  )  const [virtual]

finds the vector normal to the boundary at a point p on the boundary Parameters: p  the point on the boundary to find the normal to. Returns: a vector (i.e. 1 column value) that returns the normal to the boundary at p Exceptions: ddf::InvalidArgumentException  if p is not on the boundary Implements afl::Boundary.

virtual bool afl::BoundaryTree_4::hasNoSegments (   )  const [virtual]

returns true iff the boudndary has no segments. Such boundaries are desirable for example to store boundary conditions without a boundary. Returns: true iff the boudndary has no segments. Such boundaries Implements afl::Boundary.

virtual data_t afl::BoundaryTree_4::intersect (  const Point &  p, const Point &  v )  const [virtual]

Finds the distance from a point to the boundary in the direction of a vector. Parameters: p  The point that is being queried. v  the vector to find an intersection in the direction of Returns: the distance from the point along the vector that the boundary intersects (or the shortest distance if there are multiple intersections) of the length of the vector if there is no intersection. If p is on the boundary then the return value is 0. if p is outside the domain the distance is still positive. Implements afl::Boundary.

virtual troolean afl::BoundaryTree_4::locate (  const Point &  p  )  const [virtual]

Parameters: p  The point to locate Returns: `outside' if the point is outside the domain, `boundary' if Implements afl::Boundary.

virtual void afl::BoundaryTree_4::toXML (  std::ostream &  doc, const std::string &  componentsDir, const std::string &  baseURI )  const [virtual]

represents the segment as an XML string that will be put onto doc Parameters: doc  the stream to put the XML string on componentsDir  the path of a directory to store component files in baseURI  a URI that refers to the directory in componentsDir Implements afl::Boundary.

---

Member Data Documentation

std::list<Boundary_4> afl::BoundaryTree_4::_segments [protected]

the sub segments within this segment

---

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

• boundarytree_4.h

---