AF2RuleExistVertex Class Reference

#include <AF2RuleExistVertex.hpp>

List of all members.

Public Member Functions
	AF2RuleExistVertex (double refXCoord, double refYCoord, double coeffAlpha=1.0, double coeffBravo=0.0, double coeffCharlie=1.0)
	Constructor.
double	getX () const
	Get the ideal x-coordinate.
double	getY () const
	Get the ideal y-coordinate.
bool	isMatching (AF2Point2D const &matchPoint, double maxDeviation) const
	Check whether a vertex is a match for this ideal vertex.
Private Attributes
double	x
double	y
double	a
double	b
double	c

---

Detailed Description

Definition at line 18 of file AF2RuleExistVertex.hpp.

---

Constructor & Destructor Documentation

AF2RuleExistVertex	(	double	refXCoord,
		double	refYCoord,
		double	coeffAlpha = 1.0,
		double	coeffBravo = 0.0,
		double	coeffCharlie = 1.0
	)

Constructor.

A constructor that defines the reference coordinates along with quadratic coefficients to use in checking whether a vertex is an acceptable match for this vertex.

Parameters:

refXCoord	the x-coordinate of the ideal matching vertex
refYCoord	the y-coordinate of the ideal matching vertex
coeffAlpha	the coefficient of dx*dx to use when measuring deviation from the reference coordinates
coeffBravo	the coefficient of dx*dy to use when measuring deviation from the reference coordinates
coeffCharlie	the coefficient of dy*dy to use when measuring deviation from the reference coordinates

Definition at line 3 of file AF2RuleExistVertex.cpp.

---

Member Function Documentation

double getX

(

)

const

Get the ideal x-coordinate.

Definition at line 13 of file AF2RuleExistVertex.cpp.

double getY

(

)

const

Get the ideal y-coordinate.

Definition at line 18 of file AF2RuleExistVertex.cpp.

bool isMatching	(	AF2Point2D const &	matchPoint,
		double	maxDeviation
	)		const

Check whether a vertex is a match for this ideal vertex.

Parameters:

matchPoint	the point that is to be checked as a potential match for the ideal vertex
maxDeviation	the maximum deviation from the reference coordinates (when measured with the quadratic coefficients) that is allowed to match this vertex

Returns:

true if the coordinates of the specified point are within the specified deviation of the ideal vertex, false otherwise

Definition at line 23 of file AF2RuleExistVertex.cpp.

---

Member Data Documentation

double a [private]

Definition at line 23 of file AF2RuleExistVertex.hpp.

double b [private]

Definition at line 23 of file AF2RuleExistVertex.hpp.

double c [private]

Definition at line 23 of file AF2RuleExistVertex.hpp.

double x [private]

Definition at line 22 of file AF2RuleExistVertex.hpp.

double y [private]

Definition at line 22 of file AF2RuleExistVertex.hpp.

---

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

• AF2RuleExistVertex.hpp
• AF2RuleExistVertex.cpp