AF2AlgorithmResult Class Reference

#include <AF2AlgorithmResult.hpp>

List of all members.

Public Member Functions
	AF2AlgorithmResult ()
	Constructor for an unsuccessful result.
	AF2AlgorithmResult (const std::list< AF2Point3D * > &pointsArg, const std::list< const AF2Polygon3D * > &facesArg)
	Constructor for a successful result.
	~AF2AlgorithmResult ()
	Destructor.
	AF2AlgorithmResult (const AF2AlgorithmResult &toCopy)
	Copy constructor (throws exception)
AF2AlgorithmResult &	operator= (const AF2AlgorithmResult &rhs)
	Assignment operator (throws exception)
const std::list< const AF2Polygon3D * > *	getFaces () const
	Get a pointer to the list of faces that are in the advancing front algorithm result.
const std::list< AF2Point3D * > *	getPoints () const
	Get a pointer to the list of points that are in the advancing front algorithm result.
bool	isSuccessful () const
	Report whether the algorithm succeeded.
Private Attributes
bool	succeeded
const std::list< AF2Point3D * >	points
const std::list< const AF2Polygon3D * >	faces

---

Detailed Description

Definition at line 19 of file AF2AlgorithmResult.hpp.

---

Constructor & Destructor Documentation

AF2AlgorithmResult

(

)

Constructor for an unsuccessful result.

A constructor for an algorithm result that indicates the algorithm terminated without successfully completing.

Definition at line 10 of file AF2AlgorithmResult.cpp.

AF2AlgorithmResult	(	const std::list< AF2Point3D * > &	pointsArg,
		const std::list< const AF2Polygon3D * > &	facesArg
	)

Constructor for a successful result.

A constructor to contain the results of a successfully completed two-dimensional advancing front algorithm.

This class takes ownership of the AF2Point3D and AF2Polygon3D objects that are in the lists passed to the constructor. The aforementioned points and faces are deleted when this class is destructed.

Parameters:

pointsArg	a list of the points that are in the mesh at the successful conclusion of the advancing front algorithm
facesArg	a list of the faces that are in the mesh at the successful conclusion of the advancing front algorithm

Definition at line 16 of file AF2AlgorithmResult.cpp.

~AF2AlgorithmResult

(

)

Destructor.

Definition at line 24 of file AF2AlgorithmResult.cpp.

AF2AlgorithmResult

(

const AF2AlgorithmResult &

toCopy

)

Copy constructor (throws exception)

This object does not currently support copying, so this method is implemented to throw an exception.

Definition at line 40 of file AF2AlgorithmResult.cpp.

---

Member Function Documentation

const std::list< const AF2Polygon3D * > * getFaces

(

)

const

Get a pointer to the list of faces that are in the advancing front algorithm result.

If the result was unsuccessful, this method will return NULL.

Returns:

the list of faces added to the mesh, if the result was successful

Definition at line 56 of file AF2AlgorithmResult.cpp.

const std::list< AF2Point3D * > * getPoints

(

)

const

Get a pointer to the list of points that are in the advancing front algorithm result.

If the result was unsuccessful, this method will return NULL.

Returns:

the list of points added to the mesh, if the result was successful

Definition at line 65 of file AF2AlgorithmResult.cpp.

bool isSuccessful

(

)

const

Report whether the algorithm succeeded.

Returns:

true if the algorithm succeeded, false otherwise

Definition at line 74 of file AF2AlgorithmResult.cpp.

AF2AlgorithmResult & operator=

(

const AF2AlgorithmResult &

rhs

)

Assignment operator (throws exception)

This object does not currently support assignment, so this method is implemented to throw an exception.

Definition at line 47 of file AF2AlgorithmResult.cpp.

---

Member Data Documentation

const std::list<const AF2Polygon3D*> faces [private]

Definition at line 25 of file AF2AlgorithmResult.hpp.

const std::list<AF2Point3D*> points [private]

Definition at line 24 of file AF2AlgorithmResult.hpp.

bool succeeded [private]

Definition at line 23 of file AF2AlgorithmResult.hpp.

---

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

• AF2AlgorithmResult.hpp
• AF2AlgorithmResult.cpp